Skip to main content
GET
List call bookings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessId
string<uuid>
required

The UUID of the business.

Query Parameters

status
string

Filter by scheduled, completed, or cancelled booking state (case-insensitive). When supplied, this filter takes precedence over include_deleted, so status=cancelled returns cancelled bookings even when include_deleted is false.

Example:

"cancelled"

include_deleted
boolean
default:false

Include cancelled bookings when no status filter is supplied.

sort_by
enum<string>
default:event_start_at

Sort by a timestamp or derived booking state. Ascending state order is scheduled, completed, then cancelled.

Available options:
event_start_at,
created_at,
updated_at,
status,
state
sort_order
enum<string>
default:ASC
Available options:
ASC,
DESC
cursor
string

Opaque cursor from meta.pagination.cursor. Omit for the first page. Keep filters and sort settings unchanged between pages.

limit
integer
default:100

Maximum number of results per page.

Required range: 1 <= x <= 1000
show_total_count
boolean
default:false

Include the total number of matching results in meta.pagination.total_count.

Response

200 - application/json

A page of call bookings.

data
object[]
required
meta
object
required

Request metadata. Present on paginated list responses.