We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.
Take me there

Get all promotions

Retrieves a paginated list of all promotions.

SecurityAuthorizationToken
Request
header Parameters
required
object

Valid JSON object that must contain account, stage, date, and channel attributes. eg - {"stage":"prod","account":"5f328bf0b","date":"2020-12-12T08:00:00.000Z","channel":12}

Authorization
required
string

Authorization token or access token for the user, provided by fabric. It can be obtained after logging into fabric's copilot account.

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
offset
number >= 0

Number of records you wish to skip before selecting records

limit
number [ 1 .. 100 ]
Default: 10

Number of records to return on a single page

keyword
string

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

sortBy
string
Default: "updatedAt"

Field by which you want to sort the records

Enum: "updatedAt" "title" "startDate" "endDate"
sortOrder
string
Default: "desc"

Sorting order of the records
desc: Descending order
asc: Ascending order

Enum: "desc" "asc"
Responses
200

OK

400

Bad Request

500

Internal Server Error

post/api-offers/promo/list
Request samples
application/json
{
  • "offset": 0,
  • "limit": 10,
  • "keyword": "PROMO",
  • "sortBy": "updatedAt",
  • "sortOrder": "desc"
}
Response samples
application/json
{
  • "query": {
    },
  • "promos": [
    ]
}