v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Promotions Open Api

Get All Promotions

Retrieves all eligible, ongoing, and expired promotions on the account.

get/rm-promotions/promotions

Response

Returns a list of all promotions on the account.

countnumber required

Number of promotions in the result set.

limitnumber required

Maximum number of promotions that can be returned in the response.

skipnumber required

Number of promotions that should be skipped from the result set.

requestIdstring required

ID of request.

Example response

{
  "results": [
    {
      "_id": "63ee4b7e459ca31532f",
      "name": "Promotion 1"
    },
    {
      "_id": "63ee4b7e459ca31532f",
      "name": "Promotion 2"
    }
  ],
  "count": 10,
  "limit": 10,
  "requestId": "123e4567-e89b-12d3-a456-426614174000"
}