List appointments.

List appointments for the locations the token can access, oldest change first.

since is an inclusive (>=) filter on updatedAt, the time the appointment record last changed. order sorts by updatedAt and defaults to asc.

A cursor carries the since, order and locationUid of the listing it came from, so send it alone; any of those sent alongside it are ignored. Follow nextCursor until it is null before advancing since: since is inclusive and updatedAt values are not unique, so moving the watermark mid-traversal skips records sharing the boundary timestamp.

Required scope: read_appointments.

Query Params
string

Retrieves the page of items that comes after the cursor.

integer
0 to 100
Defaults to 10

Max number of items to return per request. Defaults to 10.

uuid

Podium unique identifier for location.

string
enum

Order by updatedAt: asc for oldest change first, desc for most recently updated first. Defaults to asc, the order to poll in: a poll interrupted partway resumes from where it stopped. desc suits a one-off look at the latest changes but is unsafe for incremental sync with since: a record updated during the traversal lands at the front and shifts every later page.

Allowed:
date-time

Return only appointments whose record changed at or after this time (inclusive). Compare against the updatedAt field in the response.

Responses

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