HomeBook an Intro CallStartup Program
API Endpoints

List appointments

get
https://api-stage.onsched.com/v3/appointments

Retrieve a list of appointments with optional filtering.

  • Supports filtering by location, resources, services, customer, and date range
  • All filter parameters are optional
  • If no filters provided, returns all company appointments
  • Supports pagination via limit and page
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

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

string

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

string

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

Responses

400

Invalid filter or pagination parameters.

401

Unauthorized.

403

Forbidden.

Updated 22 days ago

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

Updated 22 days ago