list_promo_codes
Retrieve discount codes by exact code, active status, or campaign pool. Verify whether a customer-quoted code exists and remains valid.
Instructions
List discount codes. READ-ONLY - nothing here creates or revokes one.
THERE ARE THOUSANDS. This organization has over 13,000 promo codes; do not try
to read them all. `total` answers "how many" on its own, and the filters below
answer nearly every real question without paging at all.
`filter_code` looks up one code exactly - the usual question, when someone asks
whether a code a customer quoted is real.
`filter_active` splits valid from expired or exhausted.
`filter_promo_code_pool_id` narrows to one campaign; `list_promo_code_pools`
finds the pool.
`use_count` against `max_uses` says whether a code is spent. A null `max_uses`
means unlimited, which is NOT the same as zero remaining.
Pages default to 25 rather than v1's 250. `page` is a number, not a cursor.
Requires `CSA_SKILLJAR_V1_API_KEY`, a separate credential from the v2 client.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| page_size | No | ||
| filter_code | No | ||
| filter_active | No | ||
| filter_promo_code_pool_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| page | No | ||
| rows | Yes | ||
| total | No | ||
| has_more | No | ||
| next_page | No |