ATHENA

Fetch appointment

Fetch appointment in Athena

POSThttps://api.ontross.com/api/integrations/athena/fetch-appointment

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.appointment_id

string

required

Appointment ID, e.g. '32817-4-25.755139', from the calendar or fetch-booked-appointments.

Example

"48263-4-25.864291"

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

appointment

object

The appointment detail, or null when the ID is not found.

appointment.id

string

Appointment ID.

Example

"32817-4-25.755139"

appointment.status

string

Appointment status.

Example

"f"

appointment.start

string

Start timestamp.

Example

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

appointment.end

string

End timestamp, from the appointment's last slot.

Example

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

appointment.duration

integer

Length in minutes.

Example

20

appointment.schedule_id

string

Scheduling resource the appointment sits on.

Example

"32817-4-25"

appointment.slot_ids

array

Slot IDs the appointment occupies.

appointment.comment

string

Free-text appointment comment.

Example

"Follow-up"

appointment.provider_id

string

Provider the appointment is booked under.

Example

"32817-4"

appointment.location_id

string

Location/department of the appointment.

Example

"32817-1"

appointment.appointment_type_id

string

Appointment type ID.

Example

"164"

appointment.appointment_type

string

Appointment type name.

Example

"Office Visit"

appointment.appointment_type_code

string

Appointment type code.

Example

"284"

appointment.notes

array

Scheduling notes recorded on the appointment.

appointment.confirmation

string

Confirmation status Athena displays.

Example

"Confirmed"

appointment.authorization_id

string

Referral/authorization record ID, if any.

Example

"86432"

appointment.appointment_link_id

string

Link ID when the appointment belongs to a linked set.

Example

"4680"

appointment.is_telehealth

boolean

Whether the appointment is telehealth.

Example

false

appointment.is_urgent

boolean

Whether the appointment is flagged urgent.

Example

false

appointment.clinical_encounter_id

string

Linked clinical encounter ID, when present.

Example

"987654"

appointment.patient

object

Patient on the appointment.

appointment.patient.id

string

Patient ID on the appointment.

Example

"32817-1133"

appointment.patient.name

string

Patient display name.

Example

"Example, Jordan"

appointment.patient.chart_id

string

Patient chart identifier, for chart reads.

Example

"1133"

Code

curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/athena/fetch-appointment \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"appointment_id":"32817-4-25.755139","department_id":1,"org_id":32817},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "appointment_id": "32817-4-25.755139",
    "department_id": 1,
    "org_id": 32817
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "appointment": {
      "id": "32817-4-25.755139",
      "status": "f",
      "start": "2026-10-25T09:00:00",
      "end": "2026-10-25T09:20:00",
      "duration": 20,
      "schedule_id": "32817-4-25",
      "slot_ids": [
        "string"
      ],
      "comment": "Follow-up",
      "provider_id": "32817-4",
      "location_id": "32817-1",
      "appointment_type_id": "164",
      "appointment_type": "Office Visit",
      "appointment_type_code": "284",
      "notes": [
        "string"
      ],
      "confirmation": "Confirmed",
      "authorization_id": "86432",
      "appointment_link_id": "4680",
      "is_telehealth": false,
      "is_urgent": false,
      "clinical_encounter_id": "987654",
      "patient": {
        "id": "32817-1133",
        "name": "Example, Jordan",
        "chart_id": "1133"
      }
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}