Skip to main content
GET
List Coupons

Authorizations

X-API-KEY
string
header
required

Your secret API key obtained from the Clink dashboard (Developers section)

Headers

X-Timestamp
string
required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Example:

"1783513683000"

Query Parameters

discountType
enum<string>

Discount type used to filter coupons

Available options:
percentage,
fixed_amount
durationType
enum<string>

Discount duration type used to filter coupons

Available options:
once,
repeating,
forever
pageNum
integer<int32>
default:1

Current page number. Defaults to 1.

pageSize
integer<int32>
default:20

Number of records per page. Defaults to 20. The maximum is 50; larger values are capped at 50.

Required range: x <= 50

Response

Coupons retrieved successfully

Table Paging Data Object

total
integer<int64>

Total number of records

rows
object[]

List of data

code
integer<int32>

Response status code, 200 when success

Example:

200

msg
string

Brief description of what happened, 'success' when happy case

Example:

"success"