Export the benefit audience
partner:loyalty:benefits:readDownloads the audience. Defaults to a CSV file attachment; pass format=json for a structured JSON body instead.
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.
externalId*stringExternal benefit id.
programExternalId*stringExternal id of the loyalty program that owns the benefit.
format?stringResponse format. json returns a structured body; anything else, including omitting the parameter, returns a CSV attachment.
"csv""json"organizationId?stringExternal 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.
The audience, as a CSV file attachment or — with format=json — a JSON body.
- response
curl -X GET 'https://api-prd.cf.journey.com/v1/partner/loyalty/programs/string/benefits/string/audience/export'{}