Sign in
v1

Get Visits

Gets all Visits within a given time range. The return list is ordered by start_time ascending.

IMPORTANT: This endpoint requires a date filter on appointment.startTimestamp to ensure acceptable query performance. Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.

Example filters:

  • appointment.startTimestamp|gt|2024-01-01 - appointments after January 1, 2024
  • appointment.startTimestamp|eq|2024-12-08 - appointments on December 8, 2024
  • appointment.startTimestamp|lt|2024-12-31 - appointments before December 31, 2024

You can combine the date filter with other filters using commas:

  • appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING
get/appointments/v1/visits

Query parameters

page_tokenCommonPageToken — unresolved $ref
limitinteger
sort_fieldV1SortFieldString — unresolved $ref

Defaults to appointment.start_time.

sort_directionCommonSortDirection — unresolved $ref

Defaults to ascending.

filtersCommonFilterQueryString — unresolved $ref

Required: Must include a date filter on appointment.startTimestamp (using gt, lt, or eq operators). Example: appointment.startTimestamp|gt|2024-01-01

Headers

Authorizationstring required

OAuth authentication

Response

Response with status 200

V1VisitsPage required— unresolved $ref