v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
LeadLabel

List lead label

Requires one of the following scopes: lead-labels:read, lead-labels:all, all:read, all:all

get/api/v2/lead-labels

Query parameters

limitinteger
Example:10

The number of items to return

starting_afterstring
Example:2025-03-07T00:00:00.000Z

The starting after timestamp to filter lead labels by.

searchstring
Example:Hot Lead

The search query to filter lead labels.

interest_status'positive' | 'neutral' | 'negative'
Example:positive

The interest status to filter lead labels by.

Response

The list of Lead Label

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example response

{
  "items": [
    {
      "id": "019f94cd-83e0-7429-94c8-21a0dd9220c8",
      "timestamp_created": "2026-07-24T15:45:24.448Z",
      "created_by": "019f94cd-83e0-7429-94c8-21a15cab7bb9",
      "organization_id": "019f94cd-83e0-7429-94c8-21a2305531f8",
      "label": "Hot Lead",
      "interest_status_label": "positive",
      "interest_status": 1,
      "description": "Used for marking high-priority leads"
    }
  ],
  "next_starting_after": "019f94cd-aed1-7755-99ce-51cd423d1556"
}