Partner API ExplorerCode Pools
Get a code pool
Required scope
offers:codes:readGET
Pool detail plus a page of its codes. Filter by status and cap the page with limit.
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.
poolRef*stringPool reference — the offer id backing the pool. Must match ^[A-Za-z0-9_-]{1,100}$.
Match
^[A-Za-z0-9_-]{1,100}$limit?integerMaximum number of codes to return. Must be a positive integer.
Range
1 <= valuestatus?stringReturn only codes in this state.
Value in
"available""assigned""redeemed""expired"The pool and a page of its codes.
curl -X GET 'https://api-prd.cf.journey.com/v1/partner/code-pools/string'Empty