Skip to main content
Returns short-lived offers for the open appointment slots on one date. The scheduling engine calculates the visit length from the total estimated duration of the selected services, then applies business hours, lead time, buffers, resource qualifications, capacity, date exceptions, existing work, and active holds.

Path parameters

string
required
Your booking page token (booking slug or lead token).

Query parameters

string
required
The date to check, in YYYY-MM-DD format (interpreted in the business’s timezone).
string
required
Comma-separated service IDs (e.g., 12,15). The total estimated duration of these services determines how long each slot must be. Use active Bookable service IDs from config.

Response

Returns 200 OK with the open slots.
array
Available slot offers. Each slot has an offer_token, start, end, and expires_at. The timestamps use ISO 8601. The offer token is single-use and does not reserve capacity until you create a hold.
string | null
null when slots are available. For an empty result, the reason can be date_closed, all_resources_busy, no_business_hours, no_positive_service_durations, capacity_zero, or no_eligible_resource.
Slots are also filtered by the business’s booking_min_lead_hours and its configured business hours. That’s why today’s list can come back shorter than you expect, or empty — a slot inside the minimum notice window is not offered. Both values are in the config response, so you can explain the gap to the customer rather than showing them an empty day.

Example

Send the selected offer_token to Hold or release a slot. The submit endpoint accepts a hold_token, not the displayed start time.
This endpoint is rate limited to 60 requests per 10 minutes per IP address and 2,000 requests per 10 minutes per tenant. A limited response includes Retry-After.

Errors

A date outside the allowed booking window doesn’t return an error — it returns 200 OK with an empty slots array.

Get config

Back: fetch services and settings.

Hold a slot

Next: reserve a selected offer.