Get consented sponsor leads

Read a bounded page of consented, unsuppressed leads belonging to this workspace and sponsor portal. Newest first. Compatibility: the legacy unbounded qualified total is replaced by qualifiedOnPage; entered/contactable remain aggregate totals.

GET/api/v1/leads/{token}

Authentication

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

leads:readread

Parameters

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

tokenRequired: string
limitOptional: integerRange: 1 to 100
offsetOptional: integerRange: 0 to 100000

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "token": "YOUR_VALUE",
  "limit": 25,
  "offset": 0
}

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-zA-Z0-9_-]+$"
    },
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "required": [
    "token"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "campaign": {
      "type": "string"
    },
    "sponsor": {
      "type": "string"
    },
    "entered": {
      "type": "number"
    },
    "contactable": {
      "type": "number"
    },
    "qualifiedOnPage": {
      "type": "number"
    },
    "leads": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "zip": {
            "type": "string"
          },
          "answers": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "qualified": {
            "type": "boolean"
          },
          "capturedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "email",
          "phone",
          "zip",
          "answers",
          "qualified",
          "capturedAt"
        ],
        "additionalProperties": false
      }
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "campaign",
    "sponsor",
    "entered",
    "contactable",
    "qualifiedOnPage",
    "leads",
    "limit",
    "offset",
    "hasMore"
  ],
  "additionalProperties": false
}