Skip to main content
GET
Get bookable capacity per service

Authorizations

Authorization
string
header
required

API key created in the dashboard under Settings → API Keys. Send it as Authorization: Bearer pk_....

Query Parameters

start_date
string | null

First day of the range, YYYY-MM-DD. Defaults to today in the account's default timezone.

days
integer | null

Length of the range in days, 1–31. Defaults to 7, matching the calendar agent's own search window.

service_ids
string | null

Comma-separated service IDs to restrict the answer to. Omit for all services; an explicitly empty value is rejected.

professional_ids
string | null

Comma-separated professional IDs to restrict the answer to.

event_type_id
integer | null

Restrict capacity to one event type.

duration_minutes
integer | null

Appointment length to size slots by, overriding the service default.

include
string | null

Comma-separated extras. profiles adds a per-professional breakdown under each service.

Response

OK

Response for GET /public/calendar/availability.

data
PublicCapacityDataSchema · object
required

Capacity data.

status
string
default:success

Always success.

Allowed value: "success"