Skip to main content
GET
A patient's appointments, past and future

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

x-session-token
string
required
X-Organization-Id
string
required

Target clinic organization ID

Path Parameters

patientId
string
required

Query Parameters

from
string

First date, inclusive (YYYY-MM-DD). Omit both ends for every row.

to
string

Last date, inclusive (YYYY-MM-DD).

status
enum<string>[]

Comma-separated statuses (the /v4/appointments vocabulary).

Available options:
scheduled,
confirmed,
arrived,
in_progress,
completed,
cancelled,
no_show,
rescheduled,
other,
unknown

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required

The read's payload (named by the route, e.g. appointments) plus meta.