Список лидов

Метод для получения списка Лидов с возможностью фильтрации данных.

Адрес и метод

GET /v2/lead/

Параметры

createdAt[0] string
Начало периода создания лида для выборки в формате ISO_8601

createdAt[1] string
Конец периода создания лида для выборки в формате ISO_8601

orderIds array<int> необязательный
Идентификаторы заказов Лида.

statusIds array<int> необязательный
Идентификаторы статусов Лида.

offset int необязательный
Параметр используется для управления постраничной навигацией. Указывает на порядковый номер элемента, с которого начинается выборка. По умолчанию - 0

limit int необязательный
Параметр используется для управления постраничной навигацией. Количество элементов, которое возращается за один запрос, максимально доступное значение - 100. По умолнчанию - 50

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

CURLPHP (cURL)JavaScript (fetch)

curl -X GET "https://YOUR_LINER_API_HOST/v2/lead/?createdAt[0]=2023-01-01T00:00:00Z&createdAt[1]=2023-01-31T23:59:59Z&orderIds[]=100&orderIds[]=101&statusIds[]=1&statusIds[]=2&offset=0&limit=50" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_TOKEN"

<?php

$host = 'https://YOUR_LINER_API_HOST';
$token = 'YOUR_API_TOKEN';

$query = http_build_query([
    'createdAt' => [
        '2023-01-01T00:00:00Z',
        '2023-01-31T23:59:59Z',
    ],
    'orderIds' => [100, 101],
    'statusIds' => [1, 2],
    'offset' => 0,
    'limit' => 50,
]);

$ch = curl_init($host . '/v2/lead/?' . $query);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-Api-Key: ' . $token,
    ],
    CURLOPT_TIMEOUT => 15,
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ($response === false) {
    throw new RuntimeException('cURL error: ' . curl_error($ch));
}

curl_close($ch);

echo "HTTP {$httpCode}\n";
echo $response;

const host = "https://YOUR_LINER_API_HOST";
const token = "YOUR_API_TOKEN";

const params = new URLSearchParams();
params.set("createdAt[0]", "2023-01-01T00:00:00Z");
params.set("createdAt[1]", "2023-01-31T23:59:59Z");
params.append("orderIds[]", "100");
params.append("orderIds[]", "101");
params.append("statusIds[]", "1");
params.append("statusIds[]", "2");
params.set("offset", "0");
params.set("limit", "50");

const res = await fetch(`${host}/v2/lead/?${params.toString()}`, {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": token
  }
});

const data = await res.json();
console.log("HTTP", res.status, data);

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

{
  "success": true,
  "message": "",
  "data": {
    "list": [
      {
        "id": 123,
        "name": "Иван Иванов",
        "phone": "+79001234567",
        "sourceComment": "",
        "ip": "192.168.1.1",
        "externalIdBitrix24": "B24-001",
        "externalIdAmo": "AMO-001",
        "externalIdMacro": "MACRO-001",
        "externalIdDomoplaner": "DP-001",
        "statusId": 10,
        "leadType": "straight",
        "createMethod": "api",
        "isSecondary": false,
        "previousLeadId": null,
        "nextLeadId": null,
        "planningCallDateTime": "2024-01-02T10:00:00Z",
        "priority": 0,
        "utcOffset": 3,
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z",
        "orderId": 202,
        "orderCode": "order-001",
        "vkId": "123456",
        "instagramLogin": "user_instagram",
        "telegramUserName": "user_telegram",
        "telegramPhone": "+79001234567",
        "customValues": {
          "10": "example value"
        }
      }
    ],
    "next": 50,
    "total": 12345
  }
}

Поля ответа

Поля в data

Поле	Тип	Описание
`list`	`array`	Список Лидов.
`next`	`int`	Смещение для следующего запроса.
`total`	`int`	Общее количество Лидов.

Поля в list

Поле	Тип	Описание
`id`	`int`	Идентификатор Лида в Лайнере.
`name`	`string`	Имя клиента.
`phone`	`string`	Телефон клиента (как правило, в формате E.164, например `+79001234567`).
`sourceComment`	`string`	Комментарий/лог анкеты (может быть простым текстом или JSON-строкой).
`ip`	`string`	IP пользователя (если собирается).
`externalIdBitrix24`	`string`	Идентификатор Лида в Битрикс24
`externalIdAmo`	`string`	Идентификатор Лида в Амо ЦРМ
`externalIdMacro`	`string`	Идентификатор Лида в Макро ЦРМ
`externalIdDomoplaner`	`string`	Идентификатор Лида в Домопланере
`statusId`	`int`	Текущий код статуса Лида в Лайнере.
`leadType`	`string`	Тип Лида (например, `straight` / `selection`).
`createMethod`	`string`	Способ создания Лида (API/форма/вручную — зависит от системы).
`isSecondary`	`bool` \| `null`	Признак вторичного (повторного) Лида.
`previousLeadId`	`int` \| `null`	Предыдущий Лид. Существует только, если isSecondary = true.
`nextLeadId`	`int` \| `null`	Следующий Лид. Существует только, если есть дубликат Лида.
`planningCallDateTime`	`string`	Дата/время следующего звонка (ISO-строка/Unix/внутренний формат).
`priority`	`int`	Приоритет Лида в очереди дозвона.
`utcOffset`	`int`	Смещение часового пояса клиента относительно UTC (например, `3`, `-5`).
`createdAt`	`string`	Дата/время создания Лида (обычно ISO-строка или формат системы).
`updatedAt`	`string`	Дата/время последнего обновления Лида.
`orderId`	`int`	Идентификатор заказа лида.
`orderCode`	`string`	Символьный код заказа лида.
`vkId`	`string`	Идентификатор пользователя в VK.
`instagramLogin`	`string`	Логин пользователя в Instagram.
`telegramUserName`	`string`	Username пользователя в Telegram.
`telegramPhone`	`string`	Телефон пользователя в Telegram (если известен).
`customValues`	`object`	Словарь значений пользовательских полей: ключ — ID пользовательского поля, значение — сохранённое значение этого поля.

Примечание

Выше описана структура поля data. Общий формат ответа API см. в разделе Схема запросов