Journey Docs
Partner API ExplorerWindfall

Get Windfall data for a reservation

Required scopespartner:guests:readandpartner:guests:pii:read
GET
/v1/partner/windfall/reservations/{reservationId}

Premium signal for the guest on a reservation. Requires both partner:guests:read (declared on the controller) and partner:guests:pii:read (on the handler) — the guard ANDs them.

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.

Path Parameters

reservationId*string

External reservation id. Must be a UUID.

Formatuuid

Query Parameters

organizationId?string

External organization id (HXP UUID or WorkOS organization id). Only Journey superadmin callers may set it; for a partner credential the organization is taken from the credential and this parameter is ignored.

Response Body

The reservation’s Windfall profile.

curl -X GET 'https://api-prd.cf.journey.com/v1/partner/windfall/reservations/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Empty