Get all promotions

Retrieves a paginated list of all promotions.

Authorizations

Authorization

string

headerrequired

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

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

offset

number

The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.

Required range: x > 0

limit

number

default: 10

The maximum number of records per page.

Required range: 1 < x < 100

keyword

string

Keyword to filter the matched promotion titles or promotional codes or coupon codes

sortBy

enum<string>

default: updatedAt

Field by which you want to sort the records

Available options:

updatedAt,

title,

startDate,

endDate

sortOrder

enum<string>

default: desc

Sorting order of the records<br />desc: Descending order<br />asc: Ascending order

Available options:

desc,

asc

Response

200 - application/json

query

object

Show child attributes

promos

object[]

Show child attributes