API reference/Kits

Get a kit

Try it

Read an existing workspace kit, including its saved deal and sponsor pricing.

GET/api/v1/kits/{slug}

Authentication

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

kits: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": {
    "kit": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "slug": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "enum": [
            "idea",
            "pitched",
            "sold",
            "running",
            "recapped",
            "lost"
          ]
        },
        "advertiser": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "price": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "closedOn": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "updatedAt": {
          "type": "string"
        },
        "rateCard": {}
      },
      "required": [
        "id",
        "slug",
        "state",
        "advertiser",
        "price",
        "closedOn",
        "updatedAt",
        "rateCard"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "kit"
  ],
  "additionalProperties": false
}