Get

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

Возвращает список CRM-обращений (Lead) с пагинацией и фильтрами.

Входные параметры

Название	Тип данных	Обязательность	Описание
ids	Array of Int64	Необязательный	Фильтр по ID обращений
client_ids	Array of Int64	Необязательный	Фильтр по связанным клиентам
search	String	Необязательный	Поиск по полям обращения (`title`, `description`)
responsible_user_ids	Array of Int64	Необязательный	Фильтр по ответственным
stage_ids	Array of Int64	Необязательный	Фильтр по стадиям
from_date	Int64	Необязательный	Нижняя граница `start_date` (Unix time, сек.)
to_date	Int64	Необязательный	Верхняя граница `start_date` (Unix time, сек.)
filters	Array of Filter	Необязательный	Дополнительные фильтры по основным и пользовательским полям
limit	Int32	Необязательный	Лимит выборки, при `<= 0` используется `100`, максимум `1000`
offset	Int32	Необязательный	Смещение выборки, при `< 0` используется `0`

Поля фильтра filters

Поддерживаемые поля основного фильтра (в filters[].field):

channel_id
pipeline_id
responsible_user_id
stage_id
status
title
description
amount
client_name
client_phone
external_id
start_date
end_date
sla_breached

Также поддерживаются пользовательские поля (Field) по их ключам.

Пример запроса

{
  "client_ids": [501],
  "stage_ids": [25],
  "responsible_user_ids": [15],
  "limit": 50,
  "offset": 0
}

Выходные параметры

Название	Тип данных	Описание
result	Array of Lead	Массив обращений
next_offset	Int32	Смещение для следующей страницы
total	Int64	Общее количество записей

Модель Lead включает:

client_id и вложенный client;
fields — значения дополнительных полей (см. Field);
chat_id — ID связанного чата (см. Chat и ChatMessage).

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": 105,
      "client_id": 501,
      "client": {
        "id": 501,
        "name": "Иван",
        "phone": "+998901234567"
      },
      "pipeline_id": 7,
      "stage_id": 25,
      "responsible_user_id": 15,
      "participant_user_ids": [15, 18],
      "title": "Заявка с сайта",
      "description": "Клиент хочет консультацию по тарифам",
      "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": "c2a8a79c-1948-415d-9c3b-58160d12a8de",
      "fields": []
    }
  ],
  "next_offset": 50,
  "total": 1
}