List appointments (public)

get

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

Retrieve a filtered, paginated list of appointments using the public field set.
Responses omit scheduledStartTime and scheduledEndTime and include a total count.
The 10,000-row offset cutoff for the private appointment list does not apply to this route.
Public reads use the generic public-read rate limit; a 429 response includes Retry-After.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 100

Defaults to 20

Limit the number of appointments returned (1 through 100)

page

integer

≥ 1

Defaults to 1

Page number, starting at 1

locationId

uuid

Filter appointments by location ID

customerId

uuid

Filter appointments by customer 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

status

array of strings

Filter by lifecycle status (repeat or comma-separated, case-insensitive)

status

Allowed:

from

string

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

string

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

sort

string

enum

Defaults to created

Sort by creation time or scheduled start

Allowed:

order

string

enum

Sort direction; defaults to desc for created and asc for scheduled

Allowed:

Responses

400

Invalid pagination parameters.

404

Not found.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Returns appointments

429Public read rate limit exceeded. Wait before retrying the request.