Partner API ExplorerWindfall
Get Windfall data for a guest
Required scopes
partner:guests:readandpartner:guests:pii:readGET
Looks a guest up by the hash of their PMS guest id. Requires both partner:guests:read (declared on the controller) and partner:guests:pii:read (on the handler) — the guard ANDs them.
header
AuthorizationBearer <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.
hashedPmsGuestId*stringHash of the guest id held in the property management system.
The guest’s Windfall profile.
curl -X GET 'https://api-prd.cf.journey.com/v1/partner/windfall/guests/string'Empty