Workspace API
Workspace endpoints in the Brix REST API for digital signage: 2 operations (GET, PATCH). 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/workspace
Returns the calling workspace's id and name.
curl "https://api.brixsignage.com/v1/workspace" \
-H "Authorization: Bearer $BRIX_API_KEY"Response 200: Success.
| Field | Type | Description |
|---|---|---|
data | WorkspaceRef | |
data.id | string | Workspace id. |
data.name | string | null | Workspace name; null only if the workspace row is missing. |
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.
PATCH /v1/workspace
Renames the workspace. The name must be non-empty and no more than 120 characters. Requires permission to edit billing for the whole workspace.
Notes.
- Only name can be changed here.
Request body: application/json
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | Trimmed; 1–120 characters. |
curl -X PATCH "https://api.brixsignage.com/v1/workspace" \
-H "Authorization: Bearer $BRIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Riverside Coffee"}'Response 200: Success.
| Field | Type | Description |
|---|---|---|
data | object | |
data.id | string | |
data.name | string |
Response 401: Missing, expired or revoked bearer token.
Response 403: You do not hold billing.edit for the whole workspace (a grant at one location is not enough).
Response 422: invalid: name missing, empty or over 120 characters.
Response 5XX: Server error. The body carries a requestId to quote to support.