Journey Docs
Partner API ExplorerLoyaltyPrograms

Get the benefits matrix

Required scopepartner:loyalty:benefits:read
GET
/v1/partner/loyalty/programs/{externalId}/benefits-matrix

Tier-by-benefit grid for the program: which benefits each tier is entitled to. Requires the benefits read scope rather than the programs one, because it exposes benefit configuration.

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

externalId*string

External loyalty program id.

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 tier-by-benefit matrix.

curl -X GET 'https://api-prd.cf.journey.com/v1/partner/loyalty/programs/string/benefits-matrix'
Empty