v1

Get Appointment List

Searches for appointments that match the query parameters.

get/lists/v1/appointment

Query parameters

sort_fieldV1SortFieldString — unresolved $ref

Defaults to appointment.startTimestamp.

sort_directionCommonSortDirection — unresolved $ref

Defaults to asc.

limitinteger

Defaults to 100.

page_tokenCommonPageToken — unresolved $ref
filtersCommonFilterQueryString — unresolved $ref
include_deactivatedboolean

If true, includes deactivated appointments in the results. Defaults to false.

include_merged_patient_databoolean

If true and a patient id is specified, then also include appointments from any alternative patients that are merged into this patient. Defaults to false.

Headers

Authorizationstring required

OAuth authentication

Response

Response with status 200

V1AppointmentListPage required— unresolved $ref