v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Promo Codes

get all

Returns all promo codes in a campaign

For custom components:

RaiselyComponents.api.all('promo_codes').get(params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

get/promo_codes

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Response

The resulting collection of Promo Code records

Example response

{
  "data": [
    {
      "code": "10OFF",
      "discountAmount": 10,
      "discountType": "PERCENTAGE",
      "endDate": "2022-12-01T00:00:00.000Z",
      "maxUses": 100,
      "startDate": "2022-12-01T00:00:00.000Z",
      "uses": 50,
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    }
  ],
  "pagination": {
    "total": 10,
    "pages": 2,
    "offset": 5,
    "limit": 5
  }
}