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
| Method | Path | Description |
|---|---|---|
GET | /reservation-resources | List resources |
GET | /reservation-resources/:id | Get a resource |
POST | /reservation-resources | Create a resource |
PATCH | /reservation-resources/:id | Update a resource |
DELETE | /reservation-resources/:id | Delete a resource |
The resource object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
organization_id | integer | Owning organization. Required on create; must be the API key's organization. |
resource_type | string | One of person, room, equipment, vehicle, other. Required on create. With any_available service resources, any active resource of the same type can be assigned. |
name | string | Display name, max 255 characters. Required on create. |
description | string | null | Description. |
user_id | integer | null | For person resources, the organization user this resource represents. That user receives the staff notification email when a reservation is assigned to the resource. |
capacity | integer | How many reservation units the resource can hold at the same time (each assignment uses the link's quantity_required). Default 1. |
metadata | object | null | Free-form attributes for your own use. |
color | string | null | Calendar color (hex), max 50 characters. |
is_active | boolean | Default true. Inactive resources are not picked by any_available assignment. |
created_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the resource is deleted. |
Related
- Reservation resource availability: weekly hours
- Reservation resource exceptions: blocked dates and special hours
- Reservation service resources: attach resources to services
- Reservations
Report an issue with this documentation
Please log in to report issues with our documentation.