Get Appointment List

Beta
GET

Searches for appointments that match the query parameters.

Query parameters

sort_fieldstringOptional

The string path to the field to order by. Defaults to appointment.startTimestamp. Path values are camelCase.

sort_direction"asc" or "desc"Optional

Defaults to asc.

Allowed values: ascdesc
limitintegerOptional

Defaults to 100.

page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

filtersstringOptional

A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form ‘path:operator:value’. Example: ‘patient.mrn|eq|12345’. Filters are separated by commas. Example: ‘patient.mrn|eq|12345,appointment.startDate|gt|67890’. All filters are ANDed together. Valid operators are ‘eq’, ‘gt’, ‘lt’. Path values are camelCase.

Response

This endpoint returns an object.
itemslist of objects
next_page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results