Docs
Get Surfaces
GET /surfaces
GET
/surfacesRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Returns all surfaces for the event. Surfaces are physical or virtual display locations (screens, stages, etc.) that content can be scheduled onto.
Response
Returns an array of surface objects.
| Field | Type | Description |
|---|---|---|
| id | Guid | Surface ID. |
| name | string | Display name. |
| area | object| null | Associated area (`{ id, name }`), or `null`. |
| exactLocation | string | Free-text location description. |
| rasterMap | object| null | Linked raster map (`{ id, name, status }`), or `null`. |
| contentBlocks | ContentBlock[] | Content currently scheduled on this surface. |
| contentBlocks[].id | Guid | Content block ID. |
| contentBlocks[].content | object | The scheduled content item (`{ id, name }`). |
| contentBlocks[].startTime | DateTime | Block start time. |
| contentBlocks[].endTime | DateTime | Block end time. |