Docs
Get Activity Segments
GET /Activities/{activityId}/segments
GET
/Activities/{activityId}/segmentsRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Returns all run-of-show segments for the specified activity, along with the column configuration that defines the segment table structure.
Requires EventAdmin permission on the event.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| activityId | Guid | Required | The ID of the activity. |
Response
| Field | Type | Description |
|---|---|---|
| id | Guid | Activity ID. |
| name | string | Activity name. |
| startDateTime | DateTime | Activity start time (UTC). |
| endDateTime | DateTime | Activity end time (UTC). |
| segments | array | Ordered list of segments. See segment object below. |
| configuration | object | Column configuration for the segment table. |
Segment Object
| Field | Type | Description |
|---|---|---|
| id | Guid | Segment ID. |
| name | string | Segment name. |
| index | int | Zero-based position in the run of show. |
| duration | int | Duration in minutes. |
| color | string | Display color for the segment. |
| startDateTime | DateTime | Calculated start time based on position and duration. |
| properties | array | Key-value pairs mapping column IDs to values (`columnId`, `value`). |
Configuration Object
| Field | Type | Description |
|---|---|---|
| segmentColumns | array | Ordered list of column definitions (id, index, name, size). |