Reservation resources

A resource is something a reservation occupies: a person (staff member), a room, a table, a piece of equipment or a vehicle. Resources have a capacity, a weekly availability, date exceptions, and are attached to services through service resources.

Endpoints

MethodPathDescription
GET/reservation-resourcesList resources
GET/reservation-resources/:idGet a resource
POST/reservation-resourcesCreate a resource
PATCH/reservation-resources/:idUpdate a resource
DELETE/reservation-resources/:idDelete a resource

The resource object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOwning organization. Required on create; must be the API key's organization.
resource_typestringOne of person, room, equipment, vehicle, other. Required on create. With any_available service resources, any active resource of the same type can be assigned.
namestringDisplay name, max 255 characters. Required on create.
descriptionstring | nullDescription.
user_idinteger | nullFor person resources, the organization user this resource represents. That user receives the staff notification email when a reservation is assigned to the resource.
capacityintegerHow many reservation units the resource can hold at the same time (each assignment uses the link's quantity_required). Default 1.
metadataobject | nullFree-form attributes for your own use.
colorstring | nullCalendar color (hex), max 50 characters.
is_activebooleanDefault true. Inactive resources are not picked by any_available assignment.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the resource is deleted.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.