GET/Organizations/{orgId}/events
Lists the organization's events, excluding those marked for deletion, with status, attribute values, role occupants, intake progress,
location, the caller's collaborator on each, and whether the caller can enter it. Pass locationId to list only events at one location. Needs
Organization basic access.
Path Parameters
| Field | Type | Required | Description |
|---|
| orgId | uuid | Required | |
Query Parameters
| Field | Type | Required | Description |
|---|
| locationId | uuid | Optional | |
Response
Type: GetEventsResponse[]
GetEventsResponse
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| recordState | string| null | |
| status | string| null | |
| draftedDate | date-time| null | |
| createdDate | date-time| null | |
| eventTypeId | uuid| null | |
| imageUrl | string| null | |
| hasIntake | boolean | |
| intakeSubmittedDate | date-time| null | |
| isIntakeOutstanding | boolean | |
| organization | GetEventsResponseOrg | |
| attributes | GetEventsResponseAttr[]| null | |
| roles | GetEventsResponseRoleRef[]| null | |
| collaborator | GetEventsResponseCollaboratorRef | |
| isMember | boolean | |
| location | GetEventsResponseLocationRef | |
| detailTasks | GetEventsResponseDetailTasksRollup | |
GetEventsResponseOrg
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetEventsResponseAttr
| Field | Type | Description |
|---|
| attributeId | uuid | |
| value | string| null | |
| taskState | string| null | |
| taskStatusName | string| null | |
| taskStatusColor | string| null | |
GetEventsResponseRoleRef
| Field | Type | Description |
|---|
| eventRoleId | uuid | |
| roleDefinitionId | uuid | |
| occupantId | uuid| null | |
| cardinality | string| null | |
| crewId | uuid| null | |
| collaboratorId | uuid| null | |
| taskState | string| null | |
| taskStatusName | string| null | |
| taskStatusColor | string| null | |
GetEventsResponseCollaboratorRef
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetEventsResponseLocationRef
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetEventsResponseDetailTasksRollup
| Field | Type | Description |
|---|
| state | string| null | |
| statusName | string| null | |
| statusColor | string| null | |
| doneCount | integer | |
| totalCount | integer | |
| items | GetEventsResponseDetailTasksRollupItem[]| null | |
GetEventsResponseDetailTasksRollupItem
| Field | Type | Description |
|---|
| id | uuid | |
| sourceType | string| null | |
| sourceEntityId | uuid| null | |
| name | string| null | |
| state | string| null | |
| statusName | string| null | |
| statusColor | string| null | |