GET
/
coupons

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Query Parameters

limit
integer
default:
20

The number of items to fetch. Defaults to 20.

Required range: 1 < x < 1000
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

show_archived
boolean | null

Show archived coupons as well (by default, this endpoint only returns active coupons).

redemption_code
string | null

Filter to coupons matching this redemption code.

Response

200 - application/json
data
object[]
required
pagination_metadata
object
required