Skip to main content
GET
List bookings by your external booking ID

Authorizations

Authorization
string
header
required

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

Path Parameters

externalBookingId
string
required

Your id for the booking: the externalBookingId you sent when you imported it.

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.

Response

200 - application/json

A page of the bookings imported with this id, oldest first. Empty if you haven't used it.

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: