Layouts API

GET/v1/layouts

List the workspace's multi-zone layouts, including each layout's name, resolution, and zone count.

curl "https://api.brixsignage.com/v1/layouts" \
  -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/layouts

Create a multi-zone layout with a name and optional resolution, zones, autoFullscreenForVideo, nodeId, and theme. Setting theme to { source: "brand", mode?, radius? } paints the layout using the workspace Brand Kit; omit it or set it to null for a plain canvas. Each zone can also carry a frame style (bare, card, accent, or glass), a corner radius in pixels, and a role of "logo" for a zone that shows the Brand Kit logo without needing its own 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. - The 201 body has no usedByScreenCount.

Request body application/json

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

Response 201 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 `not_shared`: zone content that is not usable at the layout's location.

Response 422 Missing name, invalid JSON, a bad theme or zone paint, zone content that does not exist or loops, or a location outside this workspace.

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

GET/v1/layouts/{id}

Retrieve one layout, including its zone geometry with each zone's content assignment and frame, radius, and role styling, its theme (the Brand Kit look, or null), and its video-fullscreen behaviour.

curl "https://api.brixsignage.com/v1/layouts/{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 layout in this workspace.

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

PATCH/v1/layouts/{id}

Edit a layout's name, resolution, zones, autoFullscreenForVideo, node, or theme. Setting theme to { source: "brand", mode?, radius? } turns the Brand Kit look on, and null turns it off. Zones accept a frame style (bare, card, accent, or glass), a radius, and a role of "logo". An invalid theme, or an unrecognized frame or role, returns 422. **Notes.** - The response is the stored row: it has no usedByScreenCount or requiresApproval (GET has them).

Request body application/json

curl -X PATCH "https://api.brixsignage.com/v1/layouts/{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 Moving it to a location where you lack layout.edit, or zone content that is not usable there (`not_shared`).

Response 404 No such layout in this workspace.

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

Response 422 Invalid JSON, a bad theme or zone paint, zone content that does not exist or loops back into this layout.

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

DELETE/v1/layouts/{id}

Delete a layout. This fails with 409 content_shared if the layout is actively shared into other spaces; pass ?force=true to delete it anyway.

curl -X DELETE "https://api.brixsignage.com/v1/layouts/{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 layout in this workspace.

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.

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

POST/v1/layouts/{id}/restore

Restore a deleted layout so it returns to the layout library.

curl -X POST "https://api.brixsignage.com/v1/layouts/{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 such layout in this workspace, or it was purged.

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

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

GET/v1/layouts/{id}/thumbnail

Retrieve a preview image of a layout, showing each zone at its real position filled with a still of its content. The same image is used everywhere the layout is previewed. Add ?fresh=1 to regenerate it after an edit.

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

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 layout in this workspace.

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

GET/v1/layouts/{id}/zones

List a layout's zones, including the content attached to each one.

curl "https://api.brixsignage.com/v1/layouts/{id}/zones" \
  -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 layout in this workspace.

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

POST/v1/layouts/{id}/zones

Add one zone to a layout, specifying its geometry, the content attached to it, and, on a themed layout, its frame (bare, card, accent, or glass), radius, and role. A zone with role "logo" does not need content of its own. **Notes.** - Editing zones returns an approved layout to draft where approval is required.

Request body application/json

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

Response 201 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 `not_shared`: the content is not usable at the layout's location.

Response 404 No such layout (or zone) in this workspace.

Response 409 `conflict`: the layout changed during the write three times running; retry.

Response 422 A bad frame, radius or role, content that does not exist, or zone content that plays this layout again (a loop).

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

PUT/v1/layouts/{id}/zones

Replace a layout's entire set of zones in one call. Send every zone you want to keep, including each zone's frame, radius, and role on a themed layout; a zone sent without those becomes a plain, unframed zone. Send zones to replace the whole list, or zoneIds (every current zone id, once) to reorder it. **Notes.** - zones is stored as sent: keys the API does not know are kept and returned.

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

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 `not_shared`: the content is not usable at the layout's location.

Response 404 No such layout (or zone) in this workspace.

Response 409 `conflict`: the layout changed during the write three times running; retry.

Response 422 `zoneIds` that are not every zone exactly once, neither `zones` nor `zoneIds`, or a bad or looping zone.

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

PATCH/v1/layouts/{id}/zones/{zoneId}

Edit one zone's geometry, attached content, or, on a themed layout, its frame, radius, or role. Send null for any of those to clear it. Rejects a change that would create a loop back into the same layout.

Request body application/json

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

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 `not_shared`: the content is not usable at the layout's location.

Response 404 No such layout (or zone) in this workspace.

Response 409 `conflict`: the layout changed during the write three times running; retry.

Response 422 A bad frame, radius or role, content that does not exist, or zone content that plays this layout again (a loop).

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

DELETE/v1/layouts/{id}/zones/{zoneId}

Remove one zone from a layout.

curl -X DELETE "https://api.brixsignage.com/v1/layouts/{id}/zones/{zoneId}" \
  -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 layout or zone in this workspace.

Response 409 `conflict`: the layout changed during the write three times running; retry.

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