GET
/
coupons
cURL
curl -X GET \
 /coupons \
 --header "Authorization: Bearer <token>"
{
  "data": [
    {
      "id": "<string>",
      "code": "10OFF",
      "name": "10% off",
      "type": "<any>",
      "percentage": 10,
      "fixedAmount": {},
      "frequency": "<any>",
      "frequencyInterval": 3,
      "maxRedemptions": "null",
      "expiresAt": "null",
      "isEnabled": true,
      "createdAt": "2021-01-01T00:00:00+00:00",
      "updatedAt": "2021-01-01T00:00:00+00:00",
      "reedemptions": true
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Query Parameters

​
page
integer
default:1

The collection page number

​
limit
integer
default:30

The number of items per page

Required range: 0 <= x <= 100

Response

200
application/json

Coupon collection

The response is of type object.