post
https://connect.agendapro.com/v3/availability
Returns the available start times of a lane: an ordered list of services that one client
takes back to back, each with an optional provider. Every start time is broken down per service,
with every provider who can take it.
Important Notes
- Requires
available_slots:readscope (it is a read, sent asPOSTbecause it carries a body). location_id,start_dateandservicesare required.servicesis ordered: the first service
starts at the start time and each next one when the previous ends. The same service may appear
more than once. A lane of one service is the simple case.servicestakes at most 10 items; a longer lane answers400 max_services_exceededbefore
any search.provider_idis per service. When omitted, any eligible provider of the location can take that
service; a start time is returned only if every service of the lane fits with some provider
(and a time resource when the service needs one).- Start times are aligned to the clock: multiples of the company's booking interval (
leap,
15 minutes by default) from midnight. A gap whose only fitting start is off that grid is not
offered (GET /v3/available_slotsmay offer it). - Each
times[].services[]entry lists inprovidersevery provider free for that service at
that time, least occupied first. Book with one of them; a service that needs a time resource
also carriestime_resource_id(one free resource) andtime_resource_ids(all of them). - There is no
end_time: add each service'sduration(inmetadata.services) to its
start_time. dates_and_providersblocks times you are already holding (for example, the lane of another
person of the same group): each entry marks that provider as busy betweenstart_timeand
end_time. Entries that are not valid times are ignored.- The company's minimum notice and booking window apply. The provider's online booking setting
does not: a provider hidden from the online booking site is offered too. - Services with options that must be chosen cannot be searched through this API
(422 invalid_service_options.bundled_missingorinvalid_service_options.cardinality). - Each item of
servicesanddates_and_providersis filtered to the fields documented below.
Errors Dictionary
Business errors arrive with their key in error and no detail (see Errors).
| Status | Error | Detail | Description |
|---|---|---|---|
| 400 | invalid_body | expected_object | Request body is not a JSON object. |
| 400 | invalid_format | services | services is not a list of objects. |
| 400 | invalid_format | dates_and_providers | dates_and_providers is not a list of objects. |
| 400 | max_services_exceeded | services | More than 10 services in services. |
| 400 | missing_services | — | services is missing or empty. |
| 400 | invalid_location_id · invalid_service_id · invalid_provider_id | — | The id is not an integer. |
| 400 | invalid_date | — | start_date is not a valid date. |
| 400 | invalid_provider | — | provider_id is a time resource, not a provider. |
| 401 | unauthorized | invalid_api_key | Missing or invalid Bearer token. |
| 401 | unauthorized | api_config_inactive | API access is inactive for this company. |
| 403 | forbidden | scope_denied | API key lacks available_slots:read scope. |
| 404 | location_not_found · service_not_found | — | The location or a service does not exist or belongs to another company. |
| 422 | date_in_the_past | — | start_date is in the past. |
| 422 | date_beyond_booking_window | — | start_date is beyond the company's booking window. |
| 422 | no_eligible_providers | — | No provider of the location can take a service of the lane that day. |
| 422 | location_is_not_active · service_is_not_active · service_provider_is_not_active | — | The location, a service or a provider is not active. |
| 422 | cross_company_service | — | A service belongs to another company. |
| 422 | cross_location_service_provider | — | A provider does not work at the location. |
| 422 | provider_not_offering_service | — | A provider does not offer its service. |
| 422 | invalid_service_options.bundled_missing · invalid_service_options.cardinality | — | The service has options that must be chosen. |
| 429 | rate_limited | burst_limit_exceeded | Per-minute request limit exceeded. |
| 429 | rate_limited | daily_quota_exceeded | Daily request quota exceeded. |
| 502 | upstream_unavailable | connection_failed | The upstream service is unavailable. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
