ATHENA

Fetch booked appointments

Fetch booked appointments in Athena

POSThttps://api.ontross.com/api/integrations/athena/fetch-booked-appointments

Request Fields

input.org_id

integer

required

Athena practice ID; also the scheduling context id.

Example

32817

input.department_id

integer

required

Runtime Athena context department.

Example

1

input.schedule_ids

array

required

Scheduling resource IDs (provider/department schedules), e.g. '32817-4-10', from the calendar filters.

input.start_date

string

required

First day of the window (YYYY-MM-DD).

Example

"2026-10-25"

input.end_date

string

required

Last day of the window (YYYY-MM-DD).

Example

"2026-10-31"

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"

Output Fields

appointments

array

Booked appointments across the requested resources and window.

appointments[].id

string

Appointment ID.

Example

"32817-4-10.976543"

appointments[].status

string

Appointment status.

Example

"f"

appointments[].start

string

Start timestamp as the scheduling API returns it.

Example

"2026-10-25T09:00:00"

appointments[].end

string

End timestamp.

Example

"2026-10-25T09:20:00"

appointments[].duration

integer

Length in minutes.

Example

20

appointments[].slot_ids

array

Slot IDs the appointment occupies.

appointments[].schedule_id

string

Scheduling resource the appointment is on.

Example

"32817-4-10"

appointments[].provider_id

string

Provider the appointment is booked under.

Example

"32817-4"

appointments[].appointment_type_id

string

Appointment type ID.

Example

"164"

appointments[].appointment_type

string

Appointment type name, from internalAppointmentType.

Example

"Office Visit"

appointments[].is_telehealth

boolean

Whether the appointment is telehealth.

Example

false

appointments[].is_virtual

boolean

Whether the appointment is virtual.

Example

false

appointments[].location_id

string

Department the schedule belongs to, derived from the schedule id (<practice>-<department>-<provider>).

Example

"32817-4"

appointments[].utc_offset

string

UTC offset carried by the start time, e.g. '-07:00'.

Example

"-07:00"

appointments[].patient

object

Patient on the appointment, when present.

appointments[].patient.id

string

Patient chart ID on the appointment.

Example

"32817-1133"

appointments[].patient.name

string

Patient display name as the calendar shows it.

Example

"Example, Jordan"

Code

curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/athena/fetch-booked-appointments \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"department_id":1,"end_date":"2026-10-31","org_id":32817,"schedule_ids":["32817-4-10"],"start_date":"2026-10-25"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "department_id": 1,
    "end_date": "2026-10-31",
    "org_id": 32817,
    "schedule_ids": [
      "32817-4-10"
    ],
    "start_date": "2026-10-25"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "appointments": [
      {
        "id": "32817-4-10.976543",
        "status": "f",
        "start": "2026-10-25T09:00:00",
        "end": "2026-10-25T09:20:00",
        "duration": 20,
        "slot_ids": [
          "string"
        ],
        "schedule_id": "32817-4-10",
        "provider_id": "32817-4",
        "appointment_type_id": "164",
        "appointment_type": "Office Visit",
        "is_telehealth": false,
        "is_virtual": false,
        "location_id": "32817-4",
        "utc_offset": "-07:00",
        "patient": {
          "id": "32817-1133",
          "name": "Example, Jordan"
        }
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}