Skip to main content
GET
/
v1
/
appointments
List appointments
curl --request GET \
  --url https://api.example.com/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "code": "success",
  "data": {
    "appointments": [
      {
        "id": "appt_01J5K8N2XRQV3M7YGWT4HB6E9C",
        "scheduledStartDate": "2025-01-20T09:00:00.000Z",
        "scheduledEndDate": "2025-01-20T09:30:00.000Z",
        "status": "confirmed",
        "isNewPatient": false,
        "patientId": "pat_01J5K8N2XRQV3M7YGWT4HB6E9C",
        "patientFirstName": "Sarah",
        "patientLastName": "Johnson",
        "patientMrn": "MRN-10042",
        "providerId": "prov_01J5K8N2XRQV3M7YGWT4HB6E9C",
        "providerFirstName": "James",
        "providerLastName": "Wilson",
        "facilityId": "fac_01J5K8N2XRQV3M7YGWT4HB6E9C",
        "facilityName": "West LA Dermatology",
        "createdAt": "2025-01-15T09:30:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 100,
      "totalCount": 250,
      "totalPages": 3
    }
  }
}

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

dateFrom
string

Filter appointments from this date (ISO 8601)

Example:

"2025-01-01"

dateTo
string

Filter appointments up to this date (ISO 8601)

Example:

"2025-12-31"

statuses
string[]

Comma-separated list of statuses to filter by

facilityId
string

Filter by facility ID

patientId
string

Filter by patient ID

sortBy
enum<string>

Sort field

Available options:
scheduledStartDate,
lastSyncedAt,
status
sortOrder
enum<string>

Sort direction

Available options:
asc,
desc

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required