INinstantly
LeadLabel

List lead label

Changed on

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

get/api/v2/lead-labels

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/lead-labels
  • Auth
    HTTP bearer

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": "01a19e6f-3f6f-7e20-861e-31cc8520f350",
      "timestamp_created": "2026-11-02T22:44:13.295Z",
      "created_by": "01a19e6f-3f6f-7e20-861e-31cd989fff00",
      "organization_id": "01a19e6f-3f6f-7e20-861e-31ce264075e4",
      "label": "Hot Lead",
      "interest_status_label": "positive",
      "interest_status": 1,
      "description": "Used for marking high-priority leads",
      "access_grants": [
        {
          "user_id": "01a19e6f-3f6f-7e20-861e-31cf4585d339",
          "access_type": 2
        }
      ]
    }
  ],
  "next_starting_after": "01a19e6f-8913-7158-8f67-d3528e8737a5"
}

Changes

  • c781051105a8Revision changes
    • breaking

      the response property // became nullable for the status

    • info

      added the optional property // to the response with the status