appointments

Get appointments search

Get filtered appointments list.

get/api/appointments/search

Query parameters

patient_idstring nullable

Patient ID

Patient ID

operator_idstring nullable

Operator ID

Operator ID

appointment_typestring nullable

Appointment type code

Appointment type code

statusstring nullable

Status (comma-separated for multiple)

Status (comma-separated for multiple)

location_typestring nullable

Location type (online/in_person)

Location type (online/in_person)

limitinteger nullable

Maximum results

Maximum results

from_datestring nullable

Created from date (ISO)

Created from date (ISO)

to_datestring nullable

Created to date (ISO)

Created to date (ISO)

appointment_startstring nullable

Appointment datetime start (ISO)

Appointment datetime start (ISO)

appointment_endstring nullable

Appointment datetime end (ISO)

Appointment datetime end (ISO)

with_op_nameboolean

Include operator name join

Include operator name join

countboolean

Return count only

Return count only

Response

Successful Response

countinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.