Docs
Get Activities
GET /Activities
GET
/ActivitiesLists the organization's activities on one schedule, chosen by the schedule query value: the caller's own crew id, the organization id for global activities, or a department or location id. Department and location schedules need read access to them unless the caller is an organization admin, valid values come from Activities_GetAllowedSchedules, and it needs an organization token and organization basic access.
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| schedule | uuid | Optional |
Response
Type: GetActivitiesResponse[]
GetActivitiesResponse
| Field | Type | Description |
|---|---|---|
| id | uuid | |
| type | string| null | |
| name | string| null | |
| description | string| null | |
| startDateTime | date-time | |
| endDateTime | date-time | |
| isAllDay | boolean | |
| recurrenceRules | GetActivitiesResponseRecurrenceRule | |
| organizers | GetActivitiesResponseParticipant[]| null | |
| locations | GetActivitiesResponseLocation[]| null |
GetActivitiesResponseRecurrenceRule
| Field | Type | Description |
|---|---|---|
| frequency | string| null | |
| interval | integer | |
| daysOfWeek | string[]| null | |
| endDate | date-time |
GetActivitiesResponseParticipant
| Field | Type | Description |
|---|---|---|
| id | uuid | |
| name | string| null |
GetActivitiesResponseLocation
| Field | Type | Description |
|---|---|---|
| id | uuid | |
| name | string| null |