List Available Slots

Returns available booking slots for a service at a location on a given date.

Results are grouped into a slots array and a metadata object. The slots array contains individual time windows; metadata summarises the query.

Important Notes

  • Results are scoped to the company associated with the API key.
  • location_id and start_date are required.
  • Requires bookings:read scope.

Errors Dictionary

StatusErrorDetailDescription
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks bookings:read scope.
404location_not_foundLocation not found or does not belong to the company.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required

Location ID to query slots for.

date
required

Date to query slots for (YYYY-MM-DD).

integer

Filter by service ID.

integer

Filter by provider ID.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json