API reference/Kits

List kits

Try it

Page through this workspace's sales kits. The legacy kits endpoint now adds bounded pagination.

GET/api/v1/kits

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.

limitOptional: integerRange: 1 to 100
offsetOptional: integerRange: 0 to 100000
stateOptional: stringValues: idea, pitched, sold, running, recapped, lost

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "limit": 50,
  "offset": 0,
  "state": "idea"
}

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "state": {
      "type": "string",
      "enum": [
        "idea",
        "pitched",
        "sold",
        "running",
        "recapped",
        "lost"
      ]
    }
  },
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "kits": {
      "type": "array",
      "items": {
        "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
      }
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "kits",
    "limit",
    "offset",
    "hasMore"
  ],
  "additionalProperties": false
}