Skip to main content
GET
List promotions

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Query Parameters

Match on the name or the promo code, case-insensitive

Maximum string length: 120
type
enum<string>
Available options:
discount,
voucher
status
enum<string>

Only promotions at this point of their date range

Available options:
scheduled,
live,
ended
limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

A page of promotions

data
object[]
total
integer

Total promotions matching the filters, ignoring pagination

limit
integer
offset
integer