Skip to main content
GET
Find bookable slots

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

x-session-token
string

The App Bridge token of the logged-in user (maxcare.appToken()), verified for this app and organization. With it the EHR is read through that user's own EHR login when they have a usable one on this EHR instance, else through the organization's system connector; without it, always the system connector. meta.actingAs says which. A token that does not verify is 401 authorizer_unverified. Sent as a header so GET requests keep it out of URLs.

X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

appointmentTypeId
string
required

Appointment type ID (atp_…)

facilityId
string

Facility ID (fac_…). Repeat or comma-separate for several.

providerIds
string

Comma-separated provider IDs (prv_…)

from
string
required

Window start (YYYY-MM-DD, inclusive)

Example:

"2026-08-01"

to
string
required

Window end (YYYY-MM-DD, inclusive)

Example:

"2026-08-07"

durationMinutes
number

Slot length in minutes. Defaults to the appointment type's default.

Example:

15

newPatient
boolean

Search as a new patient (changes type defaults on both EHRs)

Example:

true

consistency
string

Set to strong for the final pre-write validation: bypasses caches and reads the EHR live. Slower; use it once, not per keystroke. No effect on EHRs whose availability is always read live (ModMed): both values ask the EHR.

Example:

"strong"

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required