Get

[POST] .../v1/lead/get

Returns CRM leads with pagination and filters. Use this method to retrieve active CRM leads for operator queues, pipeline boards, client history, ticket follow-up and lead-to-deal conversion workflows. The response returns paged Lead records with next_offset and total, including client data, pipeline and stage ids, responsible user, participants, amount, linked ticket, converted deal id, chat id, custom fields and description mentions when include_mentions is true. The request body is required and supports filters, limit, offset, include_mentions and body filters such as ids, client_ids, responsible_user_ids, stage_ids, date bounds and search. The caller must have CRM lead select permission and pipeline ACL restrictions are applied unless the user has CRM manage-all access; missing body, denied access, invalid filters, disabled additional fields, database errors and ACL failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
include_mentions Boolean Optional Return description_mentions for the lead description.
limit Int32 Optional Requested item count. Non-positive values use the default page size.
offset Int32 Optional Result set offset. If the value is less than 0, 0 is used.
search String Optional Search by lead title and description.

Filterable Fields

Field Type Description
amount decimal
client_id int Filter by linked client IDs.
client_name string
client_phone string
description string
end_date int
external_id string
from_date int Lower start_date bound as Unix time in seconds.
id int Filter by lead IDs.
pipeline_id int
responsible_user_id int Filter by responsible user IDs.
sla_breached bool Filter by SLA breach flag. Hidden from JSON.
stage_id int Filter by stage IDs.
start_date int
status string
statuses string Filter by internal lead statuses. Hidden from JSON.
title string
to_date int Upper start_date bound as Unix time in seconds.

Request Example

{
  "filters": [
    {
      "Field": "stage_id",
      "Operator": "Equal",
      "Value": "25"
    },
    {
      "Field": "title",
      "Operator": "Like",
      "Value": "website"
    }
  ],
  "include_mentions": true,
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of Lead Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 105,
      "client_id": 501,
      "client": {
        "id": 501,
        "name": "Ivan Petrov",
        "phone": "\u002B998901234567",
        "email": "ivan.petrov@example.com",
        "fields": []
      },
      "pipeline_id": 7,
      "stage_id": 25,
      "responsible_user_id": 15,
      "participant_user_ids": [
        15,
        18
      ],
      "title": "Website request",
      "description": "Client asks for a call after 15:00",
      "description_mentions": [],
      "amount": 2500.00,
      "start_date": 1773136800,
      "end_date": null,
      "converted_deal_id": null,
      "repeat_of_lead_id": null,
      "ticket_id": 9001,
      "created_user_id": 1,
      "last_update": 1773138400,
      "chat_id": "3e73d8f2-66be-4d5a-a35d-03f7dc61a4a9",
      "fields": []
    }
  ],
  "next_offset": 0,
  "total": 1
}