[POST] .../v1/client/get
Возвращает список клиентов CRM с фильтрами и пагинацией.
Входные параметры
| Название | Тип данных | Обязательность | Описание |
|---|---|---|---|
| ids | Array of Int64 | Необязательный | Фильтр по ID клиентов |
| phones | Array of String | Необязательный | Фильтр по телефонам |
| external_ids | Array of String | Необязательный | Фильтр по внешним ID |
| emails | Array of String | Необязательный | Фильтр по email |
| search | String | Необязательный | Поиск по name, phone, email, external_id |
| responsible_user_ids | Array of Int64 | Необязательный | Фильтр по ответственным пользователям |
| filters | Array of Filter | Необязательный | Дополнительные фильтры по стандартным и кастомным полям |
| limit | Int32 | Необязательный | Лимит выборки. По умолчанию 100 |
| offset | Int32 | Необязательный | Смещение. По умолчанию 0 |
Стандартные поля для фильтрации (filters)
external_id, name, phone, email, responsible_user_id
Пример запроса
{
"phones": ["+998901112233"],
"search": "Петров",
"responsible_user_ids": [17],
"limit": 50,
"offset": 0
}
Выходные параметры
| Название | Тип данных | Описание |
|---|---|---|
| result | Array of Client | Массив клиентов |
| next_offset | Int32 | Смещение для следующей страницы |
| total | Int64 | Общее количество записей |
Пример ответа
{
"ok": true,
"result": [
{
"id": 125,
"external_id": "crm-125",
"name": "Иван Петров",
"phone": "+998901112233",
"email": "ivan.petrov@example.com",
"photo_url": null,
"description": "Повторный клиент",
"responsible_user_id": 17,
"deleted": false,
"created_user_id": 3,
"last_update": 1776305702,
"fields": []
}
],
"next_offset": 50,
"total": 1
}