Skip to main content
GET
/
api-offers
/
coupon-codes
Get a list of all coupon codes
curl --request GET \
  --url https://live.copilot.fabric.inc/api-offers/coupon-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "query": {
    "limit": 10,
    "offset": 0,
    "count": 50
  },
  "promos": [
    {
      "_id": "abcdefg1ee7ce20123456789",
      "promoId": 100013,
      "promoCodes": {
        "0": "SUMMER100",
        "1": "SUMMER20"
      },
      "promoCount": 1,
      "state": "SCHEDULED",
      "isImplicit": false,
      "title": "CREATE PROMO",
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-25T14:15:22Z",
      "isExclusive": true,
      "eligiblePriceList": [
        10000056
      ],
      "level": 1,
      "stackingType": "STACKABLE",
      "updatedAt": "2019-08-20T14:15:22Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
x-site-context
string
required
Example:

Query Parameters

​
size
integer
default:10
Required range: 1 <= x <= 100
Example:
​
startCursor
string | null
Example:
​
userId
string
Example:
​
promotionId
string
Example:
​
promoCode
string
Example:
​
status
enum<string>
Available options:
ACTIVE,
INACTIVE,
REDEEMED
Example:
​
startFrom
string<date-time>
Example:
​
startTo
string<date-time>
Example:
​
endFrom
string<date-time>
Example:
​
endTo
string<date-time>
Example:
​
additionalAttributes
string
Example:
​
promoAdditionalAttributes
string
Example:
​
title
string
Example:

Response

​
query
object
​
promos
object[]