Get a list of all coupon codes

Retrieves a paginated list of all coupon codes.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Query Parameters

size

integer

default: 10

Records the number returned by the endpoint.

Required range: 1 < x < 100

startCursor

string | null

Record pointer to get items after that record

userId

string

Filter records by the user ID.

promotionId

string

Filter records by the promotion ID.

promoCode

string

Filter records by coupon code.

status

enum<string>

Filter records by status.

Available options:

ACTIVE,

INACTIVE,

REDEEMED

startFrom

string

Filter records from a specific start date.

startTo

string

Filter records until a specific start date.

endFrom

string

Filter the records since a specific end date

endTo

string

Filter records until a specific end date.

additionalAttributes

string

Filter by the coupon code's additional attributes. This filter needs to be a valid JSON array to be able to make the search.

promoAdditionalAttributes

string

Filter by the related promotion or coupon's additional attributes. This filter needs to be a valid JSON array to be able to make the search.

title

string

Filter coupon codes by the related promotion title.

Response

200 - application/json

query

object

Show child attributes

promos

object[]

Show child attributes