Skip to main content
GET
/
coupons
List coupons
curl --request GET \
  --url https://api.salesive.com/api/v1/coupons \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Coupons retrieved",
  "data": {
    "coupons": [
      {
        "_id": "66b1f2a9c4d5e6f7a8b9c0d1",
        "code": "SUMMER20",
        "user": "66a0e1b2c3d4e5f6a7b8c9d0",
        "shop": "66a0d1c2b3a4958677564738",
        "type": "percentage",
        "discount": 20,
        "usageLimit": 100,
        "usageCount": 12,
        "usagePerUser": 1,
        "minimumOrderAmount": 5000,
        "startDate": "2026-06-01T00:00:00.000Z",
        "endDate": "2026-08-31T23:59:59.000Z",
        "active": true,
        "createdAt": "2026-05-20T10:15:00.000Z",
        "updatedAt": "2026-06-25T09:00:00.000Z"
      }
    ],
    "page": 1,
    "pages": 3,
    "total": 24
  }
}
Returns the store’s discount coupons newest first, with optional filtering by active state. The store is bound to your app token server-side — never send a shop id.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

​
page
integer
default:1

1-based page number.

Required range: x >= 1
​
limit
integer
default:10

Items per page. Defaults to 10, capped at 100.

Required range: 1 <= x <= 100
​
active
boolean

Filter by active state. Pass true to return only active coupons or false for inactive ones. Omit to return all.

Response

Paginated list of coupons.

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object

Flat pagination metadata returned alongside the items array on list responses.