Get Availability

get

https://api.joinplanbase.com/api/v1/slots/availability

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

organisation_id

integer

required

Organisation to book with

start

date-time

required

Return slots from this date.

end

date-time

required

Return slots up to this date.

provider_ids

array | null

Provider person IDs to filter on

appointment_type_id

integer

required

Appointment type to find availability for

patient_state

Patient's state, used when the appointment type requires patient-state licensure

patient_payor_id

Patient's payor, used when the appointment type requires provider payor enrollment

birth_date

Patient's date of birth, used when the appointment type has age-based match criteria

language

Patient's language, used when the appointment type has language-based match criteria

payor_name

Patient's payor, by name, used when the appointment type requires provider payor enrollment

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response