List appointments

Retrieve a paginated list of appointments. Results are filtered to the authenticated practitioner.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 200
Defaults to 50

Maximum number of results to return per page (1 – 200).

integer
≥ 0
Defaults to 0

Number of results to skip for offset-based pagination.

string
Defaults to -startDate

Field to sort by. Prefix with - for descending order.

string

Filter by client ID.

string

Filter by user (practitioner) ID.

string

Filter by appointment type ID.

string

Filter by location ID.

date-time

Filter: start date ≥ value (ISO 8601).

date-time

Filter: start date ≤ value (ISO 8601).

date-time

Filter: end date ≥ value (ISO 8601).

date-time

Filter: end date ≤ value (ISO 8601).

boolean

Filter by cancellation status.

string

Filter by appointment status.

string

Filter by payment status.

string

Filter by appointment source.

Responses

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json