Tross
Demo dataBook a demo
ZEDMED

List patient appointments

List patient bookings newest first.

POSThttps://preview.ontross.com/api/integrations/zedmed/list-patient-appointments
Request Fields
input.patient_id
integer
required
Zedmed patient identifier.
Example
900000001
input.limit
integer
Maximum number of appointments to return. Defaults to 200; maximum 500.
Example
200
Default
200
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
The patient's appointments, newest first, past ones included.
appointments[].appointment_id
integer
Booking number Zedmed assigned to this appointment.
Example
900000101
appointments[].patient_id
integer
Numeric record key identifying the person booked.
Example
900000001
appointments[].start_point
string
When the slot or appointment starts, despite the name.
Example
"2026-11-17T09:00:00"
appointments[].end_point
string
When the slot or appointment ends, despite the name.
Example
"2026-11-17T09:15:00"
appointments[].status_code
string
Short code for patient record or appointment status.
Example
"A"
appointments[].doctor_code
string
Treating physician lookup value associated with this booking.
Example
"DEMO_DOC"
appointments[].doctor_name
string
Treating doctor on this slot or appointment.
Example
"Dr Jordan Ellis"
appointments[].clinic_code
string
Site lookup value associated with this booking.
Example
"DEMO_CLINIC"
appointments[].clinic_name
string
Readable name of the clinic behind the code.
Example
"Demo Family Practice"
appointments[].resource_id
integer
Numeric key of the room or chair booked.
Example
900001
appointments[].resource_name
string
Room or chair the slot or appointment uses.
Example
"Consulting Room 2"
appointments[].appointment_type_id
integer
Numeric key behind the appointment type description.
Example
900002
appointments[].appointment_type
string
What kind of visit this is, by its description.
Example
"Standard consultation"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/zedmed/list-patient-appointments \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patient_id":900000001,"limit":200},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patient_id": 900000001,
    "limit": 200
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "appointments": [
      {
        "appointment_id": 900000101,
        "patient_id": 900000001,
        "start_point": "2026-11-17T09:00:00",
        "end_point": "2026-11-17T09:15:00",
        "status_code": "A",
        "doctor_code": "DEMO_DOC",
        "doctor_name": "Dr Jordan Ellis",
        "clinic_code": "DEMO_CLINIC",
        "clinic_name": "Demo Family Practice",
        "resource_id": 900001,
        "resource_name": "Consulting Room 2",
        "appointment_type_id": 900002,
        "appointment_type": "Standard consultation"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}