Journey Docs
Partner API ExplorerLoyaltyPrograms

Get a loyalty program

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

A program outside your organization returns 404 rather than 403, so the existence of another tenant’s program is never disclosed.

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 program.

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