API reference/Catalog

List visible promotions

Try it

Page through published promotions available to this workspace, respecting market exclusivity and plan visibility.

GET/api/v1/catalog

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.

limitOptional: integerRange: 1 to 100
offsetOptional: integerRange: 0 to 100000
monthOptional: integerRange: 1 to 12
categoryOptional: stringValues: auto, home-services, healthcare, financial, restaurant, retail, recreation, professional, agriculture, education

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "limit": 50,
  "offset": 0,
  "month": 1,
  "category": "auto"
}

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "month": {
      "type": "integer",
      "minimum": 1,
      "maximum": 12
    },
    "category": {
      "type": "string",
      "enum": [
        "auto",
        "home-services",
        "healthcare",
        "financial",
        "restaurant",
        "retail",
        "recreation",
        "professional",
        "agriculture",
        "education"
      ]
    }
  },
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      }
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "limit",
    "offset",
    "hasMore"
  ],
  "additionalProperties": false
}