List appointments

Retrieve a list of appointments with optional filtering.

  • Supports filtering by location, resources, services, customer, status, and date range
  • All filter parameters are optional
  • If no filters provided, returns all company appointments
  • Supports pagination via limit and page
  • Pagination must not skip more than 10,000 matching rows; use narrower date filters for larger histories
  • Requests are rate limited per Company; excess concurrent work may wait briefly, then receive 429 if capacity remains unavailable
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 20

Limit the number of appointments returned (max 100)

integer
≥ 1
Defaults to 1

Page number. (page - 1) * limit must not exceed 10,000.

uuid

Filter appointments by location ID

resourceIds
array of uuids

Filter appointments by resource IDs (repeat or comma-separated)

resourceIds
serviceIds
array of uuids

Filter appointments by service IDs (repeat or comma-separated)

serviceIds
uuid

Filter appointments by customer ID

status
array of strings

Filter appointments by lifecycle status (repeat or comma-separated, case-insensitive).
When omitted, appointments of every status are returned.

status
Allowed:
string

Filter appointments starting from this date (YYYY-MM-DD)

string

Filter appointments up to this date (YYYY-MM-DD)

string
enum
Defaults to created

Sort key for the full paginated result set. created orders by row insert time;
scheduled orders by occupancy start, else scheduled start after cancel.

Allowed:
string
enum

Sort direction. When omitted, defaults to desc for sort=created and asc for
sort=scheduled.

Allowed:
Responses

400

Invalid filter or pagination parameters.

401

Unauthorized.

403

Forbidden.

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