Docs
Get Activities
GET /Activities?schedule={scheduleId}
GET
/Activities?schedule={scheduleId}Required 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 a list of activities scoped to a single schedule. The schedule query parameter is a GUID that determines whose activities are returned — it acts as a scope filter rather than a distinct entity ID.
Requires EventBasicAccess on the event. When scoping to the whole event, non-admins only see activities for collaborators/areas they can read, plus global activities.
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| schedule | Guid | Required | The scope ID for the activities to retrieve. See below for valid values. |
Schedule ID Values
| Value | What is returned |
|---|---|
| Your crew ID | Activities you are a participant on (your personal schedule). |
The event ID ({{eventId}}) | All activities across the entire event (subject to your read permissions). |
| A collaborator ID | Activities the specified collaborator is a participant on. |
| An area ID | Activities assigned to the specified area. |
Passing an empty GUID is not supported and will return an error.
Response
Returns an array of activity summaries. Each item includes:
| Field | Type | Description |
|---|---|---|
| id | Guid | Unique identifier for the activity. |
| type | string | Activity type: `Activity` or `TimeFrame`. |
| name | string | Display name of the activity. |
| description | string | Optional description. |
| startDateTime | DateTime | Activity start time (UTC). |
| endDateTime | DateTime | Activity end time (UTC). |
| isAllDay | bool | Whether this is an all-day activity. |
| hasRunOfShow | bool | Whether the activity has run-of-show segments. |
| recurrenceRules | object | Recurrence configuration, if the activity repeats. |
| organizers | array | Participants with the `Organizer` role. |
| areas | array | Areas associated with this activity. |