Journey Docs
Partner API ExplorerWindfall

Get Windfall data for a member

Required scopespartner:guests:readandpartner:guests:pii:read
GET
/v1/partner/windfall/members/{memberId}

Looks a member up by their internal numeric id. 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

memberId*integer

Internal numeric member id — not the external ULID used elsewhere on this surface. A non-integer value is rejected with 400 before the handler runs.

Response Body

The member’s Windfall profile.

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