Signage templates API

Signage templates endpoints in the Brix REST API: 6 operations (GET, POST, PATCH, DELETE), with auth, permissions and curl examples.

View as Markdown

Base URL https://api.brixsignage.com. Send Authorization: Bearer $BRIX_API_KEY unless an operation says No auth. The permission chip names what the key must hold. See Authentication and scopes, Errors and rate limits and Pagination.

GET /v1/signage-templates
POST /v1/signage-templates
GET /v1/signage-templates/{id}
PATCH /v1/signage-templates/{id}
DELETE /v1/signage-templates/{id}
POST /v1/signage-templates/{id}/restore

GET/v1/signage-templates

Bearer token creative.view

Return the signage template instances in this workspace.

Parameter	In	Type	Required	Description
`limit`	query	integer	no	Page size. Omit to get every row; pass it to page by `cursor`.
`cursor`	query	string	no	The `nextCursor` of the previous page.
`count`	query	"1"	no	With `limit`: also return `total`, the number of matching rows.
`usableAt`	query	string	no	Location id: only rows usable at that location (homed there, at the workspace root, or shared to it).

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

Response 200 Success.

Field	Type	Description
`data`	array of SignageTemplate
`data[].id`	string	Signage template id.
`data[].spaceId`	string
`data[].name`	string
`data[].config`	object	The template configuration: `archetype`, `style`, `palette`, `orientation`, `content`, and the `schemaVersion` the API stamps on every write.
`data[].nodeId`	string \| null
`data[].masterId`	string \| null	The master template it was copied from, if any.
`data[].createdAt`	string	ISO-8601 timestamp (UTC).
`data[].updatedAt`	string	ISO-8601 timestamp (UTC).
`data[].deletedAt`	string \| null	Always null on these reads: deleted rows are not listed.
`nextCursor`	string \| null	Present when `?limit` was passed. Send it back as `?cursor=` for the next page; null on the last page.
`total`	integer	Total matching rows, when the route computes it.

Response 401 Missing, expired or revoked bearer token.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

POST/v1/signage-templates

Bearer token creative.create

Create a signage template instance from a configuration object containing archetype, style, palette, orientation, and content. **Notes.** - The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example lastSnapshotAt) are absent rather than null. GET returns every column.

Request body application/json

Field	Type	Required	Description
`name`	string	yes
`config`	object \| string	no	A configuration object, or the same as a JSON string. Default `{}`.
`nodeId`	string \| null	no	Home location. Default: the caller's own location.
`masterId`	string \| null	no	An id from `GET /v1/signage-master-templates`.

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

Response 201 Success.

Field	Type	Description
`data`	object
`data.id`	string	Signage template id.
`data.spaceId`	string
`data.name`	string
`data.config`	object	The template configuration: `archetype`, `style`, `palette`, `orientation`, `content`, and the `schemaVersion` the API stamps on every write.
`data.nodeId`	string \| null
`data.masterId`	string \| null
`data.createdAt`	string	ISO-8601 timestamp (UTC).
`data.updatedAt`	string	ISO-8601 timestamp (UTC).
`data.deletedAt`	string \| null	Always null on these reads: deleted rows are not listed.

Response 401 Missing, expired or revoked bearer token.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 422 Missing name, invalid JSON, or a location outside this workspace.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

GET/v1/signage-templates/{id}

Bearer token creative.view

Return one signage template instance.

Parameter	In	Type	Required	Description
`id`	path	string	yes	Signage template id.

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

Response 200 Success.

Field	Type	Description
`data`	SignageTemplate	A signage template instance in this workspace.
`data.id`	string	Signage template id.
`data.spaceId`	string
`data.name`	string
`data.config`	object	The template configuration: `archetype`, `style`, `palette`, `orientation`, `content`, and the `schemaVersion` the API stamps on every write.
`data.nodeId`	string \| null
`data.masterId`	string \| null	The master template it was copied from, if any.
`data.createdAt`	string	ISO-8601 timestamp (UTC).
`data.updatedAt`	string	ISO-8601 timestamp (UTC).
`data.deletedAt`	string \| null	Always null on these reads: deleted rows are not listed.

Response 401 Missing, expired or revoked bearer token.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 404 No such signage template in this workspace.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

PATCH/v1/signage-templates/{id}

Bearer token creative.edit

Edit a signage template instance's configuration or name. Screens currently playing it receive an updated manifest reflecting the change. **Notes.** - When the PATCH does not send config, the response carries the stored config as it is: an old row is not brought to the current schemaVersion here (GET does that).

Parameter	In	Type	Required	Description
`id`	path	string	yes	Signage template id.

Request body application/json

Field	Type	Required	Description
`name`	string	no
`config`	object \| string	no	A configuration object, or the same as a JSON string. Default `{}`.
`nodeId`	string \| null	no	Home location. Default: the caller's own location.
`masterId`	string \| null	no	An id from `GET /v1/signage-master-templates`.
`baseUpdatedAt`	string	no	Optimistic concurrency: the `updatedAt` you read. A stale value is refused with 409 `conflict` and the `current` row.

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

Response 200 Success.

Field	Type	Description
`data`	SignageTemplate	A signage template instance in this workspace.
`data.id`	string	Signage template id.
`data.spaceId`	string
`data.name`	string
`data.config`	object	The template configuration: `archetype`, `style`, `palette`, `orientation`, `content`, and the `schemaVersion` the API stamps on every write.
`data.nodeId`	string \| null
`data.masterId`	string \| null	The master template it was copied from, if any.
`data.createdAt`	string	ISO-8601 timestamp (UTC).
`data.updatedAt`	string	ISO-8601 timestamp (UTC).
`data.deletedAt`	string \| null	Always null on these reads: deleted rows are not listed.

Response 401 Missing, expired or revoked bearer token.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 403 Moving it to a location where you lack creative.edit.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 404 No such signage template in this workspace.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 409 `conflict`: the row changed since `baseUpdatedAt`; the body carries `current`.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 422 Invalid JSON.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

DELETE/v1/signage-templates/{id}

Bearer token creative.delete

Move a signage template instance to the recycle bin.

Parameter	In	Type	Required	Description
`id`	path	string	yes	Signage template id.
`force`	query	"true"	no	Delete even when it is shared into other places; the shares go with it.

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

Response 200 Success.

Field	Type	Description
`data`	object
`data.id`	string
`data.deleted`	true
`data.sharesRemoved`	integer	Shares removed with it.

Response 401 Missing, expired or revoked bearer token.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 404 No such signage template in this workspace.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 409 `content_shared`: it is shared into other places; `shareCount`, `crossSpaceShares`, `contentShares` say where. Repeat with `?force=true` to delete it and those shares.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

POST/v1/signage-templates/{id}/restore

Bearer token creative.delete

Bring back a deleted signage template instance from the recycle bin.

Parameter	In	Type	Required	Description
`id`	path	string	yes	Signage template id.

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

Response 200 Success.

Field	Type	Description
`data`	object
`data.id`	string
`data.restored`	true

Response 401 Missing, expired or revoked bearer token.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 404 No such signage template in this workspace, or it was purged.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

Response 409 `not_deleted`: it is not in the recycle bin.

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

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

Field	Type	Description
`error`	string	Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …
`message`	string	Human-readable explanation. Safe to show an operator.
`requestId`	string	Present on 5xx: quote it to support.

GET/v1/signage-templates

POST/v1/signage-templates

GET/v1/signage-templates/{id}

PATCH/v1/signage-templates/{id}

DELETE/v1/signage-templates/{id}

POST/v1/signage-templates/{id}/restore

Connect With Us

Message Received!