Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

associate
string

Narrow to one sales associate's appointments (RDV).

customer
string

Narrow to one customer's appointments by id.

store
string

Narrow to one store's appointments by store id.

status
enum<string>

Filter by status: requested | confirmed | completed | cancelled | no-show.

Available options:
requested,
confirmed,
completed,
cancelled,
no-show
timeframe
enum<string>

Filter relative to the server clock: upcoming | past.

Available options:
upcoming,
past

Response

The matching appointments (empty array when none match).

id
string
required
associateId
string
required
customerId
string
required
storeId
string
required
startsAt
string
required
endsAt
string
required
status
enum<string>
required
Available options:
requested,
confirmed,
completed,
cancelled,
no-show
actorId
string
required
bookedAt
string
required
Example: