Skip to main content
GET
List 1:1 appointments (paginated).

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

service
string

Filter to one service by its uuid.

staff
string

Filter to one staff member by uuid.

contact
string

Filter to one contact by uuid.

status
string

Filter by booking status (confirmed, completed, cancelled, no_show, etc.).

from
string<date>

Only appointments scheduled at/after this datetime (UTC).

to
string<date>

Only appointments scheduled at/before this datetime (UTC).

per_page
integer

Items per page (alias: limit). Default 25, max 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object