API reference
Every customer endpoint in the Brix REST API, grouped by resource, with auth, required permission and a curl example. Generated from the OpenAPI spec.
View as Markdown · For AI agents: the full docs index is at /llms.txt
470 operations in 59 groups. Base URL https://api.brixsignage.com. Every path starts with /v1.
This reference is generated from the OpenAPI 3.1 spec at https://api.brixsignage.com/v1/openapi.json. A copy of the same file is served at https://brixsignage.com/openapi.json. Point a code generator, Postman or an agent at either file for the same data in machine-readable form.
428 of 470 operations have request and response schemas, each checked against the running API by a contract test.
- Account (part 1 of 4)13 operations
- Account (part 2 of 4)26 operations
- Account (part 3 of 4)14 operations
- Account (part 4 of 4)19 operations
- Ad slots12 operations
- AI4 operations
- Alert channels1 operation
- Alert events2 operations
- Alert rules6 operations
- Alerts1 operation
- API keys4 operations
- App instances8 operations
- Approvals5 operations
- Apps12 operations
- Audit5 operations
- Banners6 operations
- Billing groups6 operations
- Casts3 operations
- Celebration entries6 operations
- Connected apps2 operations
- Connectors2 operations
- Creative overrides3 operations
- Creatives8 operations
- Cross space shares3 operations
- Data sources14 operations
- Device preassignments3 operations
- Emergencies5 operations
- Emergency templates4 operations
- Folder shares6 operations
- GDPR3 operations
- Interactions2 operations
- Layouts12 operations
- Me1 operation
- Media (part 1 of 3)4 operations
- Media (part 2 of 3)22 operations
- Media (part 3 of 3)16 operations
- Media folders6 operations
- Media sync3 operations
- Org nodes12 operations
- Playlists (part 1 of 2)6 operations
- Playlists (part 2 of 2)8 operations
- Power policies5 operations
- Proof10 operations
- Recall9 operations
- Recycle bin2 operations
- Roles6 operations
- Schedules10 operations
- Screen groups9 operations
- Screens (part 1 of 4)4 operations
- Screens (part 2 of 4)17 operations
- Screens (part 3 of 4)13 operations
- Screens (part 4 of 4)17 operations
- Screenshots2 operations
- Search1 operation
- Serial templates5 operations
- Shared in4 operations
- Shared with Me4 operations
- Shares3 operations
- Signage master templates1 operation
- Signage templates6 operations
- Social accounts5 operations
- SSO connections11 operations
- Status2 operations
- Uptime1 operation
- Users9 operations
- Web recorder6 operations
- Webhooks8 operations
- Workspace2 operations