Skip to main content
GET
List bookings

Authorizations

Authorization
string
header
required

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

Query Parameters

page[size]
number | null

How many results to return per page, from 1 to 500. Defaults to 100.

Required range: 1 <= x <= 500
Example:

100

page[after]
string | null

Pass page.next from the previous response to get the next page.

page[before]
string | null

Pass page.prev from the previous response to get the previous page.

source
enum<string>

Filter to bookings with the given source (INTERNAL, EXTERNAL, or API).

Available options:
INTERNAL,
EXTERNAL,
API
status
enum<string>

Filter to bookings with the given status.

Available options:
CONFIRMED,
CANCELLED,
WITHDRAWN,
DEFERRED,
PENDING,
REFUNDED,
REFUNDING,
TO_BE_TRANSFERRED,
TRANSFERRED_EVENTS,
TRANSFERRED_TO_CREDIT,
FAILED
externalBookingId
string | null

Filter to the booking with your given external booking id.

externalOrderId
string | null

Filter to the bookings of one imported order, by the order id you supplied. Returns every booking of that order, so a purchase that produced several comes back together.

Required string length: 1 - 255

Response

200 - application/json

A page of bookings.

data
BookingSummary · object[]
required
page
PageCursor · object
required

Where you are in a paginated list.

Pass next as page[after] to get the next page, or prev as page[before] to get the previous one. An empty cursor means there are no more pages in that direction. Treat cursors as opaque strings.

Example: