Skip to main content
GET

Authorizations

x-publisher-token
string
header
required

Publisher token, as displayed in the Publisher Dashboard.

Path Parameters

couponName
string
required

Coupon name.

Example:

"summer26"

Query Parameters

limit
integer

Maximum number of promo codes to return.

Example:

1000

page
integer

Page number to retrieve.

Example:

1

sortDirection
enum<string>
default:asc

Sort direction of results by createdAt.

Available options:
asc,
desc
Example:

"desc"

isActive
boolean

Filter by active status.

Example:

true

Response

Promo codes retrieved successfully.

promoCodes
object[]

List of promo codes.

totalCount
integer

Total number of promo codes matching the query.

Example:

42

totalPages
integer

Total number of pages matching the query.

Example:

1

hasNextPage
boolean

Whether there is an additional page of results.

Example:

true

page
integer

Current page number.

Example:

1

limit
integer

Maximum number of promo codes per page.

Example:

1000