Skip to main content
GET
Retrieve a paginated list of all bookings associated with your partner account.

Authorizations

Headout-Auth
string
header
required

Query Parameters

offset
integer
default:0

Number of bookings to skip for pagination.

limit
integer
default:20

Number of bookings to return per page. Maximum is 20. Values above 20 are capped to 20.

Required range: x <= 20

Response

Successful response

items
object[]

The bookings in this page of results.

nextUrl
string | null

Full URL to fetch the next page of results. Null if on the last page.

prevUrl
string | null

Full URL to fetch the previous page of results. Null if on the first page.

total
integer

Total number of bookings associated with your partner account.

nextOffset
integer | null

Offset value to use in the next request to retrieve the following page.