Docs
Get Surface
GET /surfaces/{surfaceId}
GET
/surfaces/{surfaceId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Returns full detail for a single surface, including description, raster map, area, location, and all scheduled content blocks.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| surfaceId | Guid | Required | The ID of the surface to retrieve. Replace `{{surfaceId}}` in the URL. |
Response
| Field | Type | Description |
|---|---|---|
| id | Guid | Surface ID. |
| name | string | Display name. |
| description | string | Description text. |
| rasterMap | object| null | Linked raster map (`{ id, name, status }`), or `null`. |
| area | object| null | Associated area (`{ id, name }`), or `null`. |
| exactLocation | string | Free-text location description. |
| contentBlocks | ContentBlock[] | All content blocks scheduled on this surface. |
| contentBlocks[].id | Guid | Content block ID. |
| contentBlocks[].content | object | Scheduled content item (`{ id, name }`). |
| contentBlocks[].startTime | DateTime | Block start time. |
| contentBlocks[].endTime | DateTime | Block end time. |