list_promo_code_pools
Read-onlyIdempotent
Retrieve promo-code pools to inspect discount and validity settings. Since codes only track usage, pools determine how much a code is worth.
Instructions
List promo-code pools - the campaigns individual codes belong to.
A pool carries the DISCOUNT and the VALIDITY WINDOW; the codes in it carry only
their own usage. So "how much is this code worth" is a question about the pool,
not the code.
`percent_off` and `price_cents` are alternatives: a pool sets one or the other.
`starts_at` / `expires_at` bound when codes in it can be redeemed, and
`expire_content` says whether access granted through the pool expires too - a
different thing from the code expiring.
Over 4,000 pools here. Read `total` rather than paging through them.
Requires `CSA_SKILLJAR_V1_API_KEY`, a separate credential from the v2 client.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| page_size | No | ||
| filter_name | No | ||
| filter_offer_id | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| page | No | ||
| rows | Yes | ||
| total | No | ||
| has_more | No | ||
| next_page | No |