Approvals API

GET /v1/approvals

Auth: Bearer token. Permission: screen.view.

List approval requests the caller is allowed to see, newest first. Use ?state= to narrow the list to requests still awaiting a decision. The response is capped because approval history only grows over time. Newest first. The route needs screen.view, but each request is listed only if the caller can also view (or approve) that content kind at its location — e.g. playlist.view for a playlist. A screen.view-only key gets an empty list.

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

Auth: Bearer token. Permission: screen.view.

Open an approval request for a piece of content. The authenticated caller becomes the requester. Decide the request with POST /v1/approvals/:id/decide, or cancel it with POST /v1/approvals/:id/withdraw. Notes. - The request goes to the content's own location; a nodeId in the body is ignored. The content's review state becomes pending. - The requester is the caller (apikey:<id> for a key).

Request body: application/json

curl -X POST "https://api.brixsignage.com/v1/approvals" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contentKind":"playlist","contentId":"pl_2b3c4d5e6f7a8b9c","contentName":"Lobby Loop","note":"New spring menu"}'

Response 200: Success: A request for this content is already pending: that request is returned and nothing is created.

Response 201: Success.

Response 401: Missing, expired or revoked bearer token.

Response 403: The content is approved, and you do not hold its approve permission (playlist.approve, …) at its location.

Response 404: No such content, or it is at a location where you do not hold screen.view.

Response 422: contentKind, contentId or contentName is missing.

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

GET /v1/approvals/{id}

Auth: Bearer token. Permission: screen.view.

Retrieve one approval request. If the request falls outside what you are allowed to see, this returns 404 rather than 403, so its existence is not revealed. Notes. - Besides screen.view, the caller must be able to view or approve the content kind at its location (e.g. playlist.view); otherwise 404.

curl "https://api.brixsignage.com/v1/approvals/{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 request, or you cannot view (or approve) that kind of content at its location.

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

POST /v1/approvals/{id}/decide

Auth: Bearer token. Permission: screen.view.

Approve or reject a pending approval request. A reason is required when rejecting. The decision is applied to the underlying content's approval status. Decides the CURRENT level of the chain. Approving the last level lets the content air; approving an earlier level passes it to the next. Besides screen.view, the caller must be a named approver for the level or hold the content kind's approve permission (playlist.approve, schedule.approve, …) at the level's location.

Request body: application/json

curl -X POST "https://api.brixsignage.com/v1/approvals/{id}/decide" \
  -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 eligible to decide this level, or self_approval (another approver exists).

Response 404: No such request.

Response 409: already_decided.

Response 422: Bad decision, or a rejection without decisionNote.

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

POST /v1/approvals/{id}/withdraw

Auth: Bearer token. Permission: screen.view.

Cancel your own pending approval request. The content it was attached to returns to draft status. Notes. - The content's review state goes back to draft.

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

Response 200: Success.

Response 401: Missing, expired or revoked bearer token.

Response 403: You are not the requester, and not an approver for the current level.

Response 404: No such request.

Response 409: already_decided: the request is no longer pending.

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