Journey Docs
Partner API ExplorerGuests

List guests

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

Guests derived from reservations at the venues the credential can reach. This is a reservation-derived roster, not identity resolution: the same person staying at two venues may appear once per venue.

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
checkInTo?string
limit?number
Range1 <= value <= 100
memberLinked?string

'true' = members only, 'false' = non-members only.

offset?number
Range0 <= value
organizationId?string
propertyId?string
q?string

Response Body

A page of guests, newest reservation first.

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

Verify a fulfillment code

Previous Page

List benefits

Next Page