Signage master templates API
Signage master templates endpoints in the Brix REST API: 1 operation (GET). Each lists its path, auth, required permission and a curl example.
View as Markdown · For AI agents: the full docs index is at /llms.txt
Base URL https://api.brixsignage.com. Send Authorization: Bearer $BRIX_API_KEY unless an operation says Auth: none or Auth: no API key. The Permission line names what the key must hold. See Authentication and scopes, Errors and rate limits and Pagination.
Every 4xx and 5xx response below returns this body:
| 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-master-templates
Return the published catalog of signage templates curated by Brix. This catalog is shared across all workspaces rather than scoped to one, and is the only source of the masterId values required when creating a signage template. Drafts and deleted entries are not included.
Notes.
- Not paginated: the whole published catalog comes back, sorted by sortOrder then name.
curl "https://api.brixsignage.com/v1/signage-master-templates" \
-H "Authorization: Bearer $BRIX_API_KEY"Response 200: Success.
| Field | Type | Description |
|---|---|---|
data | array of SignageMasterTemplate | |
data[].id | string | |
data[].name | string | |
data[].description | string | null | |
data[].industry | string | null | |
data[].archetype | string | null | |
data[].sortOrder | integer | |
data[].format | "engine" | "creative" | "pack" | engine: config is the template. creative: creative is a finished design to create a creative from. pack: creative.screens holds one finished design per screen of a multi-screen set (for example three menu TVs side by side); create one creative from each. |
data[].config | object | The template configuration: archetype, style, palette, orientation, content, and the schemaVersion the API stamps on every write. |
data[].creative | any | null | creative format: the design (the body POST /v1/creatives takes). pack format: { screens: [{ name?, ...design }] }, in screen order. Null otherwise. |
data[].updatedAt | string | ISO-8601 timestamp (UTC). |
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.