API reference/Catalog

Get a promotion

Try it

Read a visible promotion's concept, scripts, sales brief, mechanic and suggested sponsor rate card.

GET/api/v1/catalog/{slug}

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

catalog:readread

Parameters

Named placeholders belong in the path. Other arguments use query parameters.

slugRequired: string

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "slug": "YOUR_VALUE"
}

Input schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z0-9][a-z0-9-]*$"
    }
  },
  "required": [
    "slug"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "promotion": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "promotion"
  ],
  "additionalProperties": false
}