Elation List appointments

POSThttps://preview.ontross.com/api/integrations/elation/list-appointments

input.provider_id

string

required

Physician user id, the user_id field from list-physicians, not id. (required — provide this or provider_name)

Example

"306223"

input.start_date

string

required

First included calendar day of the requested schedule.

Example

"2030-01-08"

input.end_date

string

required

Last included calendar day, no earlier than the first.

Example

"2030-01-14"

auth_id

string

required

Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.

Example

"00000000-0000-4000-8000-000000000000"

provider_id

string

Physician user id, the user_id field from list-physicians, not id.

Example

"306223"

start_date

string

First included schedule day formatted as YYYY-MM-DD.

Example

"2030-01-08"

end_date

string

Last included schedule day formatted as YYYY-MM-DD.

Example

"2030-01-14"

count

integer

Number of schedule entries included in this response.

Example

0

appointments

array

The provider's appointments across the requested date range.

appointments[].id

string

Schedule entry identifier returned by the appointment feed.

Example

"999000000000301"

appointments[].appt_time

string

Appointment start stamped MM/DD/YYYY HH:MM:SS with a UTC offset.

Example

"01/08/2026 09:30:00 -0600"

appointments[].duration

integer

Appointment length in minutes, null when Elation omits it.

Example

30

appointments[].status

string

Display state returned by the schedule feed.

Example

"Scheduled"

appointments[].provider_id

string

Physician user id, the user_id field from list-physicians, not id.

Example

"999000000000201"

appointments[].patient_id

string

Patient whose chart is read or written, from search-patients.

Example

"999000000000101"

appointments[].patient_name

string

Patient name as the provider schedule feed formats it.

Example

"TESTPATIENT, AVERY"

appointments[].appt_type_id

string

Appointment type id only, since the schedule feed returns no label.

Example

"999000000000302"

appointments[].description

string

Additional text supplied with the schedule entry.

Example

"Monthly blood pressure follow-up"

appointments[].is_telehealth

boolean

Whether the appointment is booked as a telehealth visit.

Example

true

appointments[].is_blocking

boolean

Whether the entry blocks the schedule rather than booking a patient.

Example

false

curl --request POST \
  --url https://preview.ontross.com/api/integrations/elation/list-appointments \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"provider_id":"306223","start_date":"2030-01-08","end_date":"2030-01-14"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "provider_id": "306223",
    "start_date": "2030-01-08",
    "end_date": "2030-01-14"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "provider_id": "306223",
    "start_date": "2030-01-08",
    "end_date": "2030-01-14",
    "count": 0,
    "appointments": [
      {
        "id": "999000000000301",
        "appt_time": "01/08/2026 09:30:00 -0600",
        "duration": 30,
        "status": "Scheduled",
        "provider_id": "999000000000201",
        "patient_id": "999000000000101",
        "patient_name": "TESTPATIENT, AVERY",
        "appt_type_id": "999000000000302",
        "description": "Monthly blood pressure follow-up",
        "is_telehealth": true,
        "is_blocking": false
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}