Docs

Get Activities Run Of Show

GET /Activities/run-of-show?schedule={scheduleId}

GET/Activities/run-of-show?schedule={scheduleId}

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.

Returns a lightweight list of activities for a given schedule scope, suitable for building a run-of-show view. Only returns activities that have at least one segment.

Requires EventBasicAccess permission on the event.

Query Parameters

FieldTypeRequiredDescription
scheduleGuidRequiredThe scope ID for the activities to retrieve. Accepts the event ID, a collaborator ID, or an area ID.

Response

Returns an array of activity summaries. Each item includes:

FieldTypeDescription
idGuidUnique identifier for the activity.
typestringActivity type: `Activity` or `TimeFrame`.
namestringDisplay name of the activity.
startDateTimeDateTimeActivity start time (UTC).
endDateTimeDateTimeActivity end time (UTC).
isAllDayboolWhether this is an all-day activity.