Skip to main content
GET
List coupons

Authorizations

Authorization
string
header
required

Send either an API token or an OAuth access token as Authorization: Bearer <token>. See the Authentication page for details.

Headers

Privy-Account-Id
string

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Query Parameters

kind
enum<string>

Only pools of this kind.

Available options:
master,
unique
platform
enum<string>

Only pools on this platform.

Available options:
manual,
shopify,
bigcommerce,
woocommerce
title
string

Case-insensitive substring match on the pool title.

page
integer
default:1

Page number (starts at 1).

Required range: x >= 1
per_page
integer
default:40

Number of results per page. Values outside 10–100 are clamped to the nearest bound.

Required range: 10 <= x <= 100

Response

A paginated list of coupon pools.

data
object[]
note
string

Fixed caveat that redemption/usage data is not tracked by Privy.

pagination
object