Skip to main content
GET
/
v1
/
admin
/
promotions
List promotional offers
curl --request GET \
  --url https://{operatorDomain}/v1/admin/promotions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "discountPercent": 123,
      "discountAmountCents": 123,
      "currency": "<string>",
      "scope": {
        "productIds": [
          "<string>"
        ],
        "categoryIds": [
          "<string>"
        ],
        "destinationIds": [
          "<string>"
        ],
        "marketIds": [
          "<string>"
        ],
        "audiences": [],
        "fareCodes": [
          "<string>"
        ],
        "cabinGradeCodes": [
          "<string>"
        ]
      },
      "conditions": {
        "minPax": 123,
        "pastGuestOnly": true,
        "soloTravelerOnly": true,
        "childTravelerOnly": true,
        "familyOnly": true
      },
      "validFrom": "2023-12-25",
      "validUntil": "2023-12-25",
      "code": "<string>",
      "stackable": true,
      "active": true,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Query Parameters

active
boolean
code
string
applicationMode
enum<string>
Available options:
auto,
code
status
enum<string>
Available options:
active,
scheduled,
expired,
archived
scopeKind
string
validFrom
string
validUntil
string
limit
integer
default:50
Required range: x <= 200
offset
integer
default:0

Response

200 - application/json

Promotional offers

data
object[]