Get a campaign

Read an owned campaign's mechanic, dates and configuration. A public campaign token from another workspace does not grant API access.

GET/api/v1/campaigns/{token}

Authentication

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

campaigns:readread

Parameters

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

tokenRequired: string

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "token": "YOUR_VALUE"
}

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-zA-Z0-9_-]+$"
    }
  },
  "required": [
    "token"
  ],
  "additionalProperties": false
}

Response schema

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