Skip to content

List coupon pools

Requires VIEWER.

projectId
required
string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

Pools.

Media typeapplication/json
object
pools
Array<object>
object
id
string
projectId
string
name
string
form
string
Allowed values: random generic personal
codeLength
integer
totalCount
integer
perUserLimit
integer
validityDays
integer | null
benefitsJson
string | null
status
string
Allowed values: draft generating active exhausted archived
createdAt
string
updatedAt
string

Missing/invalid path input (e.g. projectId) or invalid JSON body.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}