Skip to main content
GET
Every booking of a period and where its money stands

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Query Parameters

from
string<date>
required

First day of the period (YYYY-MM-DD), on the organization's clock.

to
string<date>
required

Last day of the period, inclusive.

clubId
integer

Only the bookings of this club.

areaTypeId
integer

Only the bookings of this area type (a court, a room).

instructorIds
string

Only the bookings these instructors teach or coach, comma-separated.

Example:

"3,7"

paymentState
enum<string>

Only the rows whose money stands so.

Available options:
unpaid,
partial,
paid,
refunded,
covered,
free
type
string

Only the rows of one resource type, a value from typeOptions.

Example:

"court|Padel"

status
string

Only the rows with this booking status.

Example:

"no_show"

limit
integer
default:100

How many rows a page holds.

Required range: 1 <= x <= 500
offset
integer
default:0

How many rows to skip.

Required range: x >= 0

Response

A page of the audit

period
object
summary
object

Over every booking of the period, before the row filters (paymentState, type, status) narrow the rows.

typeOptions
object[]

Each resource type the period holds, with the value the type filter takes.

total
integer

Every row the filters keep, across all pages.

limit
integer
offset
integer
rows
object[]

Still-owing first, then the most recent first.