Player

List players

If no filter is provided it will list all available players.

GET

/api/v1/player

List players

curl --request GET \
  --url 'https://voyager.korbyt.com/api/v1/player?name=sample_player&id=1&status=%3Cstring%3E&tags=%5B%22first%22%5D&page=1&healthcheck=true&newplayers=true&verbose=true' \
  --header 'Authorization: Bearer <token>'

[
  {
    "addresses": "10.0.0.21,fe80::1",
    "checkedin": "2024-09-12T16:37:20.383Z",
    "heartbeat": "2024-09-12T16:41:23.727Z",
    "id": "747",
    "model": "Korbyt Windows Player",
    "name": "LOBBY-WIN-01",
    "osversion": "Microsoft Windows 10 IoT Enterprise LTSC 10.0.19044",
    "output": "1",
    "status": "Inactive",
    "token": "XXXXX-XXXXX-01",
    "version": "3.21.2.3652"
  },
  {
    "checkedin": "2025-05-01T22:41:42.305Z",
    "id": "780",
    "name": "XXXXX-XXXXX-02",
    "output": "1",
    "status": "Pending",
    "token": "XXXXX-XXXXX-02"
  },
  {
    "checkedin": "2026-08-21T05:46:55.196Z",
    "heartbeat": "2026-08-21T05:46:54.034Z",
    "id": "812",
    "model": "PWA",
    "name": "BREAKROOM-PWA-01",
    "output": "1",
    "status": "Inactive",
    "token": "XXXXX-XXXXX-03",
    "version": "3.9"
  },
  {
    "addresses": "10.0.0.42",
    "checkedin": "2024-09-19T18:39:42.022Z",
    "id": "748",
    "model": "HS145",
    "name": "BrightSign-XXXXXXXXXXXX",
    "osversion": "BrightSign 9.0.127",
    "output": "1",
    "status": "Pending",
    "token": "XXXXXX-XXXXXX-XX",
    "version": "3.12.4"
  }
]

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

namestringquery

player name

Example: sample_player

idintegerquery

player id

Example: 1

statusstringquery

active or inactive

tagsstringquery

json formatted list of tags (any matching tags)

Example: ["first"]

pageintegerquery

page of results to select

Example: 1

healthcheckbooleanquery

returns 1000 players with less information per player

Example: true

newplayersbooleanquery

returns players within 4 hours of the current time (UTC)

Example: true

verbosebooleanquery

adds information per player

Example: true

Response

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

itemsobject[]

Show child attributes

Still need help? Share an idea