GET/organizations/{orgId}/reservations
Lists reservations across the organization's events for the roster, one row per reservation with its
event, resource type, need, order, who fills it, status, origin and planned schedule, including replaced
ones. from and to limit it to reservations whose schedule overlaps that range, and ones with no schedule
are always kept; a from that is not before to is refused. Archived events are left out unless
includeArchived is true. Requires organization basic access.
Path Parameters
| Field | Type | Required | Description |
|---|
| orgId | uuid | Required | |
Query Parameters
| Field | Type | Required | Description |
|---|
| from | date-time | Optional | |
| to | date-time | Optional | |
| includeArchived | boolean | Optional | |
Response
Type: GetOrganizationReservationsResponse[]
GetOrganizationReservationsResponse
| Field | Type | Description |
|---|
| id | uuid | |
| event | GetOrganizationReservationsResponseEventInfo | |
| fulfillmentId | uuid | |
| fulfillmentName | string| null | |
| type | GetOrganizationReservationsResponseTypeInfo | |
| fulfillmentItemId | uuid| null | |
| procurementResourceId | uuid| null | |
| procurement | GetOrganizationReservationsResponseProcurementInfo | |
| group | GetOrganizationReservationsResponseGroupInfo | |
| order | GetOrganizationReservationsResponseOrderInfo | |
| resource | GetOrganizationReservationsResponseResourceInfo | |
| personKey | string| null | |
| orgPersonKey | string| null | |
| orgCrewId | uuid| null | |
| notInCrewDatabase | boolean | |
| status | string| null | |
| origin | string| null | |
| isReplaced | boolean | |
| replacedByReservationId | uuid| null | |
| settlement | string| null | |
| rateCardId | uuid| null | |
| notes | string| null | |
| scheduleBlockCount | integer | |
| actualHours | number | |
| actualStart | date-time| null | |
| actualEnd | date-time| null | |
| plannedBlockCount | integer | |
| plannedStart | date-time| null | |
| plannedEnd | date-time| null | |
| plannedBlocks | GetOrganizationReservationsResponseBlockInfo[]| null | |
| reservationSpans | GetOrganizationReservationsResponseSpanInfo[]| null | |
| footprint | GetOrganizationReservationsResponseSpanInfo[]| null | |
GetOrganizationReservationsResponseEventInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetOrganizationReservationsResponseTypeInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| trackingType | string| null | |
GetOrganizationReservationsResponseProcurementInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetOrganizationReservationsResponseGroupInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetOrganizationReservationsResponseOrderInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetOrganizationReservationsResponseResourceInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| label | string| null | |
| identifier | string| null | |
| crewId | uuid| null | |
GetOrganizationReservationsResponseBlockInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| typeId | uuid | |
| typeName | string| null | |
| startDateTime | date-time | |
| endDateTime | date-time | |
GetOrganizationReservationsResponseSpanInfo
| Field | Type | Description |
|---|
| startDateTime | date-time | |
| endDateTime | date-time | |