Skip to main content
GET
/
v1
/
promotions
List
curl --request GET \
  --url https://{defaultHost}/v1/promotions \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/promotions"
  },
  "data": [
    {
      "id": "6de00a65-e9aa-4740-9aa3-d9691403abb7",
      "object": "promotion",
      "archived": false,
      "archived_at": null,
      "code": "TESTCODE",
      "expired": false,
      "max_redemptions": null,
      "metadata": {},
      "redeem_by": null,
      "times_redeemed": 0,
      "affiliation": null,
      "coupon": "8f578279-009c-42fd-9a49-950f20f64d8a",
      "customer": null,
      "discarded_at": null,
      "created_at": 1771429887,
      "updated_at": 1771429887
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
affiliation_ids[]
string[]

Only return objects that belong to the given affiliations.

​
archived
boolean

Only return objects that are archived or not archived.

​
coupon_ids[]
string[]

Only return objects with the given coupon IDs.

​
customer_ids[]
string[]

Only return objects that belong to the given customers.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

​
query
string

The query to be used for full text search of this collection.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.