Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your platform API key (haau3_sk_…), sent as Authorization: Bearer <key>.

Headers

X-Request-Id
string<uuid>

An id of your own for this request, as a UUID. It comes back in the X-Correlation-Id header and is kept with haau3's record of the request. Any value that is not a UUID is ignored. See https://docs.haau3.com/errors#request-ids.

Query Parameters

status
enum<string>
default:free

Slot availability state to return. Defaults to free.

Available options:
free,
busy,
busy-unavailable,
busy-tentative
publisher
string

Filter to a single publisher (source) by slug, such as zocdoc or defacto. See GET /v1/scheduling/publishers for the available slugs.

Minimum string length: 1
serviceTypeCode
string

Filter by service type code (as published by the source). A slot matches when any of its serviceTypes carries the code. A comma-separated list (up to 100) matches a slot carrying any of them.

Minimum string length: 1
npi
string

Filter by the provider's National Provider Identifier: a clinician's, or an organization's when a healthcare service is the provider. Ten digits; a comma-separated list (up to 100) matches a slot whose provider carries any of them. Matched as the publisher sent it, in either NPI identifier system, across every publisher.

Minimum string length: 1
specialty
string

Filter by specialty: a slot matches when its provider's specialties or its schedule's specialties carry the code. Send code to match it in any code system, or system|code to match it in that system only. Codes are each publisher's own and are not translated between code systems, so one code finds the publishers that use it; GET /v1/scheduling/specialties lists them. A specialty sent as text only cannot be matched. A comma-separated list (up to 100) matches any of them.

Minimum string length: 1
appointmentType
string

Filter by appointment type.

Minimum string length: 1
acceptingPatients
enum<string>

Filter 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.

Available options:
newpt,
existptonly,
existptfam
isVirtual
boolean

Filter to virtual (true) or in-person (false) slots.

city
string

Filter by the location's city.

Minimum string length: 1
state
string

Filter by the location's state.

Minimum string length: 1
startAfter
string<date-time>

Only slots starting at or after this instant: ISO 8601 with seconds and an offset, such as 2026-07-06T13:00:00-04:00 or 2026-07-06T17:00:00Z. A value without seconds is refused. When absent, slots start from now unless includePast=true.

startBefore
string<date-time>

Only slots starting at or before this instant: ISO 8601 with seconds and an offset, such as 2026-07-06T13:00:00-04:00 or 2026-07-06T17:00:00Z. A value without seconds is refused.

includePast
boolean
default:false

Include slots that started before now. Defaults to false: with no startAfter, results start from now. An explicit startAfter applies as given either way.

limit
integer
default:25

Page size: the number of provider locations, from 1 to 100. Defaults to 25.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of provider locations to skip for pagination. Defaults to 0.

Required range: 0 <= x <= 9007199254740991

Response

The matching provider locations, and their total number before paging.

providerLocations
object[]
required
total
integer
required
Required range: 0 <= x <= 9007199254740991