Get Availability

Get a list of provider availability for a given date and service.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Account-TokenstringRequired

The account token that is associated with the end user linked to this account

Query parameters

appointmentTypeenumRequired
Allowed values:
clinicIdintegerRequired
durationintegerOptional

Duration in minutes of appointment

providerIdslist of integersRequired

The providers that you want to get availability for

serviceIdslist of integersRequired

The services/types of appointments that you want to get availability for. See getAppointmentTypes for how to view the list of available services and their ids.

startDatedateRequired

Response

This endpoint returns an object.
statusenum
Allowed values:
availabilityobject

Errors