Journey Docs
Partner API ExplorerReservations

List reservations

Required scopepartner:reservations:read
GET
/v1/partner/reservations

Reservations at the venues the credential can reach, members and non-members alike. For the benefit-fulfillment task queue, use GET /v1/partner/arrivals instead.

Authorization

headerAuthorizationBearer <token>

WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.

Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected with 401 Invalid or expired token; send it in X-API-Key instead.

WorkOS organization API keys are not accepted yet.

Query Parameters

bookingStatus?string
Value in"confirmed""canceled""inquiry""other"
checkInFrom?string

Check-in window lower bound (inclusive). Defaults to yesterday.

checkInTo?string

Check-in window upper bound (inclusive). Defaults to 30 days out.

cursor?string

Opaque keyset cursor from the previous page's nextCursor.

Preferred over offset for walking a multi-property roster: it cannot skip or duplicate a row when the PMS sync writes underneath the caller, and it does not make the database walk and discard the skipped rows the way a deep OFFSET does. Ignored (and offset honored instead) when the caller supplies a sort this cursor does not describe.

The token carries only the page's last (check_in_date, external_reservation_id) — the PUBLIC reservation uuid, never an internal PK — and no authorization: scope is re-resolved from the token on every request.

A stale, hand-edited or otherwise malformed cursor is IGNORED (you get page one), never a 400 and never a 500: both fields are shape-checked before they can reach SQL.

offset is unchanged and still works; supplying both means the cursor wins, and the response then echoes offset: 0 because that is the offset actually applied.

limit?number
Range1 <= value <= 100
memberLinked?string

'true' = linked to a member only, 'false' = unlinked only.

offset?number
Range0 <= value
organizationId?string

Required for global/Journey-admin callers; ignored for partner tokens.

propertyId?string

Narrow to one venue. Must be inside the caller's scope or the request 403s.

propertyIds?array<string>

Narrow to SEVERAL venues in one request — property EXTERNAL ids.

Additive alternative to propertyId, which keeps working unchanged. When both are supplied the result is their union. Omitting both still means "everything in my scope".

EVERY id is checked against the caller's resolved scope; a single out-of-scope id 403s the whole request rather than being dropped, so a caller can never mistake a silently-narrowed page for a complete one.

Items1 <= items
q?string

ILIKE across confirmation code, PMS id, guest name and guest email.

Response Body

A page of reservations.

curl -X GET 'https://api-prd.cf.journey.com/v1/partner/reservations'
Empty