Reservations API

Manage reservations for your organization: list, create, update status and details, and align behavior with the Reservations page and AI assistant reservation tools.

Overview

The Reservations API uses the /reservations service. Reservations link a contact to a reservation service at a specific start time, with optional deal, company, preferred resource, and reservation custom fields.

Base endpoint: /reservations

Typical flows

List services — GET /reservation-services (filter by organization_id, often is_active: true).
Check availability — GET /reservation-available-slots with service_id, date (YYYY-MM-DD), organization_id, optional resource_id.
Create reservation — POST /reservations with start_datetime from a slot, contact_id, service_id, party_size, etc.
Update reservation — PATCH /reservations/:id (reschedule, notes, status, cancellation metadata).

To configure bookable services, resources, schedules, and public booking pages, use the Reservation services, Reservation resources, Reservation booking links, and related endpoints documented in this section.

Reservation object (fields used by the app)

json

Status values

Value	Description
`pending`	Awaiting confirmation (if the service requires confirmation).
`confirmed`	Confirmed booking.
`cancelled`	Cancelled; set `cancelled_at` (ISO datetime) and `cancelled_by` when cancelling from the org (e.g. `"organization"`).
`completed`	Visit completed.
`no_show`	Customer did not show.

AI assistants and internal tools

Assistants can use internal tools that map to the same data model. Enable them via

PATCH

/ai-assistants/:id under internal_tools.tools:

Tool key	Maps to
`find_reservations`	List/search reservations (`GET /reservations`).
`create_reservation`	Create reservation (`POST /reservations`).
`update_reservation`	Update reservation (`PATCH /reservations/:id`).
`get_reservation_services`	List services (`GET /reservation-services`).
`get_available_slots`	Available slots (`GET /reservation-available-slots`).

Reservation custom fields

Reservation-specific custom fields are managed with entity_type: "reservation" on the Custom Fields API (same pattern as contacts). When creating or updating a reservation, send values in custom_fields_by_key keyed by each field’s key. List definitions with:

GET

/custom-fields and query organization_id, entity_type: "reservation", $limit (max 50 per request; paginate with $skip if needed).

Related endpoints

Service	Purpose
`/reservation-services`	Services (duration, capacity, pricing, booking rules).
`/reservation-resources`	Bookable resources (people, rooms, equipment).
`/reservation-service-resources`	Link resources to services (required/optional, quantity).
`/reservation-resource-availability`	Weekly recurring hours per resource.
`/reservation-resource-exceptions`	Blocked dates or special hours.
`/reservation-available-slots`	Computed slots for a service and date.
`/reservation-booking-links`	Public booking page configuration.

Service images and booking link logo/cover uploads use

POST

/s3-url-signing with types such as reservation-service-image, booking-link-logo, and booking-link-cover; then

PUT

the file to the signed URL and store the returned public URL on the service or booking link page_config.

Report an issue with this documentation

Please log in to report issues with our documentation.