Player Group

List player groups

If no filter is provided it will instead list off available player groups.

GET

/api/v1/group

List player groups

curl --request GET \
  --url 'https://voyager.korbyt.com/api/v1/group?name=sample_group&id=1&status=active&tags=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "64",
    "name": "Briefing Center",
    "players": [
      {
        "id": "532",
        "name": "BRIEFCTR-01",
        "output": "1",
        "status": "Inactive"
      },
      {
        "id": "498",
        "name": "MULTI-OUT-PLAYER",
        "output": "2",
        "status": "Pending"
      }
    ],
    "type": "Dynamic",
    "updated": "2018-10-15T16:14:32.354Z"
  },
  {
    "description": "For testing",
    "id": "79",
    "name": "Test Group",
    "players": [],
    "type": "Static",
    "updated": "2019-08-15T21:53:20.618Z"
  },
  {
    "id": "95",
    "name": "webOS Group",
    "players": [
      {
        "id": "212",
        "name": "webOS-XXXXXXXXXXXX",
        "output": "",
        "status": "Inactive"
      }
    ],
    "type": "Static",
    "updated": "2019-09-10T12:38:21.374Z"
  }
]

Authorizations

Authorizationstringheaderrequired

Access token from POST /api/v1/auth/login

Query Parameters

namestringquery

group name

Example: sample_group

idintegerquery

group id

Example: 1

statusstringquery

active or inactive

Example: active

tagsstringquery

json formatted list of tags (any matching tags)

Response

Success (schema inferred from live response captured 2026-10-07)

itemsobject[]

Show child attributes

Still need help? Share an idea