Skip to main content
GET
Search the EHR's appointment finder

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_…)

timeFrame
enum<string>
required

Search mode. first_available: the earliest openings. specific_date: one clinic day (date). time_frame: within offset offsetUnit from today. date_range: from–to, both inclusive. A mode's own parameters are required and any other mode's parameters are refused.

Available options:
first_available,
specific_date,
time_frame,
date_range
Example:

"date_range"

facilityId
string

Facility ID (fac_…). Repeat or comma-separate for several. Defaults to every facility on the EHR instance; facility-limited API keys must pass it.

providerIds
string

Comma-separated provider IDs (prv_…). Applied to the EHR's answer: the finder itself always searches every provider.

date
string

Clinic calendar day (YYYY-MM-DD). specific_date only.

Example:

"2026-11-02"

from
string

Window start (YYYY-MM-DD, inclusive). date_range only.

Example:

"2026-11-02"

to
string

Window end (YYYY-MM-DD, inclusive). date_range only; at most 120 days after from.

Example:

"2026-11-15"

offset
number

How far ahead to search, in offsetUnit. time_frame only.

Example:

2

offsetUnit
enum<string>

Unit of offset. time_frame only.

Available options:
days,
weeks,
months
weekday
enum<string>[]

Only these weekdays. Repeat or comma-separate for several.

Available options:
monday,
tuesday,
wednesday,
thursday,
friday,
saturday,
sunday
timeOfDay
enum<string>

Part of the day. Defaults to anytime.

Available options:
anytime,
morning,
afternoon,
evening
display
enum<string>

Result order as the EHR presents it. Defaults to by_provider; the slots are the same.

Available options:
by_provider,
by_time
durationMinutes
number

Slot length in minutes (5–480). Defaults to the appointment type's default.

Example:

15

alternateDurations
boolean

Let the type's alternate durations match. Defaults to true.

Example:

true

allowOverride
boolean

Also return slots that need a staff override; they carry overrideAllowed: true. Defaults to false.

Example:

false

afterFirstAppointment
boolean

Passed to the EHR's search as is; its effect is unverified. Defaults to false.

Example:

false

bufferMinutes
number

Passed to the EHR's search as is (0–240); presumably minutes kept free around booked appointments, effect unverified. Defaults to 0.

Example:

0

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required