Screen groups API

GET/v1/screen-groups

List the screen groups in your workspace. Each group includes the number of screens in it and the IDs of the screens you have access to see.

curl "https://api.brixsignage.com/v1/screen-groups" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/screen-groups

Create a named group of screens. Optionally pass screenIds to add screens to the group at creation time.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/screen-groups" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 201 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 409 `name_taken`: a group with this name exists.

Response 422 `name` missing, or `screenIds` empty / over 5000.

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/screen-groups/{id}

Get one screen group and the screens in it. Requesting a group that belongs to a different workspace returns a not-found error.

curl "https://api.brixsignage.com/v1/screen-groups/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such group in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

PATCH/v1/screen-groups/{id}

Update a screen group's name or description. A name already used by another group in your workspace is refused with a name_taken conflict error.

Request body application/json

curl -X PATCH "https://api.brixsignage.com/v1/screen-groups/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No screen group with this id.

Response 409 `name_taken`.

Response 422 `name` is empty.

Response 5XX Server error. The body carries a `requestId` to quote to support.

DELETE/v1/screen-groups/{id}

Delete a screen group. The screens in the group are not affected, and the group's membership is kept so it can be fully restored with POST /v1/screen-groups/:id/restore.

curl -X DELETE "https://api.brixsignage.com/v1/screen-groups/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/screen-groups/{id}/restore

Restore a deleted screen group along with its original screen membership. A group that is not currently deleted is refused with a conflict error.

curl -X POST "https://api.brixsignage.com/v1/screen-groups/{id}/restore" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No screen group with this id.

Response 409 `not_deleted`, or a live group has the same name.

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/screen-groups/{id}/screens

Add screens to a group. Adding a screen already in the group has no additional effect. A screen from another workspace, a deleted screen, or a screen outside your organization scope is skipped and counted in the response, but not identified individually.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/screen-groups/{id}/screens" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such group.

Response 422 `screenIds` empty or over 5000.

Response 5XX Server error. The body carries a `requestId` to quote to support.

DELETE/v1/screen-groups/{id}/screens/{screenId}

Remove one screen from a group. Returns a not-found error if the screen is not currently in the group.

curl -X DELETE "https://api.brixsignage.com/v1/screen-groups/{id}/screens/{screenId}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/screen-groups/{id}/screens/remove

Remove one or more screens from a group. This only removes the screens from the group; the screens themselves are not affected. Removing a screen that is not in the group has no effect.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/screen-groups/{id}/screens/remove" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such group.

Response 422 `screenIds` empty or over 5000.

Response 5XX Server error. The body carries a `requestId` to quote to support.