screens

List screens

Changed on

List the screens in your workspace, including each screen's organization node, assigned content, online status, and player settings. Pass limit (and optionally cursor) to page through results; without limit, the full list is returned. Results are limited to the organization nodes you can see.

Notes.

  • The state object is a lean subset here (connection, currentContent, cache, proof, sync, telemetry.identity/display); GET /v1/screens/{id} returns the full snapshot.
  • nextCursor is a screen id (keyset by id), not the base64 cursor the shared resource routes use.
get/v1/screens

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/screens
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size (max 500). Omit to get every screen.

cursorstring

The nextCursor of the previous page (a screen id).

qstring

Only screens whose name contains this text (not case-sensitive). % and _ match themselves.

nodeIdstring

Only screens at or under this location. An unknown location is 404.

Response

Success.

nextCursorstring nullable

Present only when limit was passed; null on the last page.

Example response

{
  "data": [
    {
      "id": "scr_1a2b3c4d5e6f7a8b"
    }
  ]
}

Changes

  • 02fd3665dc7dRevision changes
    • warning

      added the new awaiting_payment enum value to the //// response property for the response status

    • info

      added the required property // to the response with the status