Skip to main content
GET
List booking batches

Authorizations

Authorization
string
header
required

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

Headers

Accept-Language
string
default:en

Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.

Example:

"da-DK, da;q=0.9, en;q=0.8"

Request-ID
string

Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the Request-ID response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

teamUuid
string<uuid>
required

Team uuid. All resources are scoped to this team.

Query Parameters

state
enum<string>

Filter by current batch state. open accepts validated members; start locks membership and queues sequential processing. completed means every member has an outcome, including failures. stopping/stopped indicate a stop request; stopped waits for the in-flight booking to finish. Terminal batches cannot restart.

Available options:
open,
queued,
processing,
stopping,
completed,
stopped
identifier
string

Exact private reference.

reference
string

Exact public reference.

cursor
string

Opaque cursor returned by this endpoint. Omit it for the first page. Keep all filters, sort order and per_page unchanged within a page sequence. For tracking polls, use the documented resume_cursor once next is null.

Minimum string length: 1
per_page
integer
default:100

Maximum number of resources per page.

Required range: 1 <= x <= 1000

Response

Booking batches.

data
object[]
required

Navigation links for a cursor-paginated collection. Follow next or prev with GET; returned URLs preserve the selected filters, sort order, page size and sync boundary where applicable.

meta
object
required