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. |
Auth: Bearer token.
Read who a Files folder is shared with: its own shares (a location, person or role, with use or edit access), shares inherited from folders above it, and general access. You must be able to edit the folder. A folder in another workspace answers 404.
| Parameter | In | Type | Required | Description |
|---|
folderId | path | string | yes | Identifier for folderId. |
curl "https://api.brixsignage.com/v1/folder-shares/{folderId}" \
-H "Authorization: Bearer $BRIX_API_KEY"
Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
Response 5XX: Server error. The body carries a requestId to quote to support.
Auth: Bearer token. Permission: media-folder.shared.
Replace who a Files folder is shared with. A location includes its sub-locations, and access is use or edit. Content already on screens keeps playing when a share is removed. You need permission to share folders and edit rights on this folder.
| Parameter | In | Type | Required | Description |
|---|
folderId | path | string | yes | Identifier for folderId. |
curl -X PUT "https://api.brixsignage.com/v1/folder-shares/{folderId}" \
-H "Authorization: Bearer $BRIX_API_KEY"
Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
Response 5XX: Server error. The body carries a requestId to quote to support.
Auth: Bearer token.
Before saving a share, see who the proposed targets would give access to: a count and up to 100 names, limited to people you are allowed to see. Nothing is saved.
| Parameter | In | Type | Required | Description |
|---|
folderId | path | string | yes | Identifier for folderId. |
curl -X POST "https://api.brixsignage.com/v1/folder-shares/{folderId}/reach" \
-H "Authorization: Bearer $BRIX_API_KEY"
Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
Response 5XX: Server error. The body carries a requestId to quote to support.
Auth: Bearer token.
List folders that were unshared from the caller in the last 30 days. Content already on screens keeps playing, but the files can no longer be picked.
curl "https://api.brixsignage.com/v1/folder-shares/notices" \
-H "Authorization: Bearer $BRIX_API_KEY"
Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
Response 5XX: Server error. The body carries a requestId to quote to support.
Auth: Bearer token. Permission: folder.share.
Find the people, locations and roles matching q that you can share a folder with. Each list is limited to what you are allowed to see.
curl "https://api.brixsignage.com/v1/folder-shares/targets" \
-H "Authorization: Bearer $BRIX_API_KEY"
Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
Response 5XX: Server error. The body carries a requestId to quote to support.
Auth: Bearer token.
List one level of the location tree for picking a share target. Without parentId this is the top level. A location you cannot pick is included with selectable: false when it leads to one you can.
curl "https://api.brixsignage.com/v1/folder-shares/targets/locations" \
-H "Authorization: Bearer $BRIX_API_KEY"
Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.
Response 5XX: Server error. The body carries a requestId to quote to support.