Search appointment slots
Returns provider availability slots matching the filters, with pagination. Requires a valid API key.
Authorizations
Your platform API key (haau3_sk_…), sent as Authorization: Bearer <key>.
Query Parameters
Slot availability state to return. Defaults to free.
free, busy, busy-unavailable, busy-tentative Filter to a single publisher (source) by slug — e.g. zocdoc, defacto. See GET /v1/scheduling/publishers for the available slugs.
1Filter by service type code (as published by the source).
1Filter by appointment type.
1Filter to slots accepting patients of this kind (HL7 accepting-patients CodeSystem: newpt | existptonly | existptfam). Slots marked nopt (not accepting patients) are never served, so nopt is not a valid filter value. Lenient: a slot that does not declare an accepting-patients code matches any value (absence never hides a slot); a slot that declares one must equal the requested value.
newpt, existptonly, existptfam Filter to virtual (true) or in-person (false) slots.
Filter by the location's city.
1Filter by the location's state.
1Only slots starting at or after this ISO 8601 instant (with offset).
Only slots starting at or before this ISO 8601 instant (with offset).
Opaque actor key from GET /v1/scheduling/actors. When set, returns exactly that booking entity's slots — the drill-down for a card. Treat the value as opaque; do not parse it.
1Page size (1–100). Defaults to 25.
1 <= x <= 100Number of slots to skip for pagination. Defaults to 0.
0 <= x <= 9007199254740991