Docs

Get

GET /Activities/{activityId}

GET/Activities/{activityId}

Returns one organization activity with its locations, crew and department participants. Non-admins can only open a global activity, one they take part in, or one on a department or location they can read; the id comes from Activities_GetActivities, and it needs an organization token and organization basic access.

Path Parameters

FieldTypeRequiredDescription
activityIduuidRequired

Response

FieldTypeDescription
iduuid
organizationIduuid
typestring| null
namestring| null
descriptionstring| null
startDateTimedate-time
endDateTimedate-time
exactLocationstring| null
isGlobalboolean
isAllDayboolean
recurrenceRulesGetActivityResponseRecurrenceRule
locationsGetActivityResponseLocationItem[]| null
crewMembersGetActivityResponseActivityParticipant[]| null
departmentsGetActivityResponseActivityParticipant[]| null

GetActivityResponseRecurrenceRule

FieldTypeDescription
frequencystring| null
intervalinteger
daysOfWeekstring[]| null
endDatedate-time

GetActivityResponseLocationItem

FieldTypeDescription
iduuid
namestring| null

GetActivityResponseActivityParticipant

FieldTypeDescription
iduuid
namestring| null
isRequiredboolean
rolestring| null