Content folders API

Content folders endpoints in the Brix REST API: 6 operations (GET, POST, PATCH, DELETE). 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:

FieldTypeDescription
errorstringMachine-readable code: unauthorized, forbidden, not_found, validation_error, conflict, rate_limited, internal_error, …
messagestringHuman-readable explanation. Safe to show an operator.
requestIdstringPresent on 5xx: quote it to support.

GET /v1/content-folders

Auth: Bearer token.

List the folders of the Designs, Playlists and Layouts lists. Set kind to design, playlist or layout to get the folders of one list. Without kind, the answer contains the folders of each list that you have permission to view.

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

POST /v1/content-folders

Auth: Bearer token.

Create a folder in the Designs, Playlists or Layouts list. Send kind and name. Send parentId to put the folder inside a different folder; folders can be 4 levels deep. A folder only files items. It does not change who can see an item or what plays on a screen.

curl -X POST "https://api.brixsignage.com/v1/content-folders" \
  -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.

GET /v1/content-folders/{id}

Auth: Bearer token.

Get one folder of the Designs, Playlists or Layouts list. A folder in a different workspace, or in a part of the workspace that you cannot access, returns a not-found error.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
curl "https://api.brixsignage.com/v1/content-folders/{id}" \
  -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.

PATCH /v1/content-folders/{id}

Auth: Bearer token.

Rename a folder, move it into a different folder, or file items. Send the ids of items of the same kind as the folder in addItems to put them in the folder, or in removeItems to take them out. You can file at most 500 items in one call. You need edit permission on each item that you file.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
curl -X PATCH "https://api.brixsignage.com/v1/content-folders/{id}" \
  -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.

DELETE /v1/content-folders/{id}

Auth: Bearer token.

Move a folder and its subfolders to the recycle bin. The items in them are not deleted; they move up to the parent of the deleted folder. The folder stays in the recycle bin for 30 days.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
curl -X DELETE "https://api.brixsignage.com/v1/content-folders/{id}" \
  -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.

POST /v1/content-folders/{id}/restore

Auth: Bearer token.

Restore a folder from the recycle bin together with its subfolders. The items that the delete moved up go back into the folder, unless they are in a different folder now.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for id.
curl -X POST "https://api.brixsignage.com/v1/content-folders/{id}/restore" \
  -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.