Docs
Get Schedule Roll Up
GET /Organizations/{organizationId}/schedule
GET
/Organizations/{organizationId}/scheduleRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Returns activities across all events in the organization that are either globally visible or include the authenticated user as a participant. User names are hydrated from the Organization API. Use this for organization-wide calendar and schedule views.
Requires OrganizationBasicAccess permission.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| organizationId | Guid | Required | The organization to roll up the schedule for. |
Response
Returns an array of activities across all events.
| Field | Type | Description |
|---|---|---|
| id | Guid | Unique activity ID. |
| eventId | Guid | The event this activity belongs to. |
| type | string | Activity type (`Activity` or `TimeFrame`). |
| name | string | Activity name. |
| startDateTime | DateTime | Activity start. |
| endDateTime | DateTime | Activity end. |
| isAllDay | bool | Whether this is an all-day activity. |
| recurrenceRules | RecurrenceRule | Recurrence configuration, if the activity repeats. |
| users | Participant[] | Participants in this activity. |
RecurrenceRule
| Field | Type | Description |
|---|---|---|
| frequency | string | Recurrence frequency (e.g. `Daily`, `Weekly`). |
| interval | int | How often the frequency repeats. |
| daysOfWeek | string[] | Days the recurrence applies to. |
| endDate | DateTime | When the recurrence ends. |
Participant
| Field | Type | Description |
|---|---|---|
| id | Guid | User ID. |
| name | string | Display name. |