Skip to content

List loyalty programs

Requires VIEWER.

projectId
required
string

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

Programs.

Media typeapplication/json
object
programs
Array<object>
object
id
string
projectId
string
name
string
pointCurrency
string
pointsPerCurrency
integer
expiryDays
integer | null
monthlyIssueBudget
integer | null
status
string
Allowed values: active paused 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"
}