Перейти к содержанию

Список пользовательских полей

Получение списка пользовательских полей в Лайнере. Поля отсортированы по sort по возрастанию.


Адрес и метод

GET /v2/custom-field/


Параметры

essence string необязательный
Сущность, к которой привязано пользовательское поле. Доступные значения: orders, leads.

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

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


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

curl -X GET "https://YOUR_LINER_API_HOST/v2/custom-field/?essence=orders&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([
    'essence' => 'orders', // необязательно: orders | leads
    'offset' => 0,
    'limit' => 50,
]);

$ch = curl_init($host . '/v2/custom-field/?' . $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("essence", "orders"); // необязательно: orders | leads
params.set("offset", "0");
params.set("limit", "50");

const res = await fetch(`${host}/v2/custom-field/?${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,
        "title": "Источник",
        "type": "select",
        "essence": "leads",
        "params": [
          {
            "code": "option_1",
            "sort": 10,
            "title": "Вариант 1",
            "isDeleted": false
          }
        ],
        "sort": 10,
        "defaultValue": null,
        "allowEmpty": false,
        "showAlways": true,
        "apiOnly": false
      }
    ],
    "total": 1,
    "next": 0
  }
}

Поля ответа

Поля в data

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

Поля в list

Поле Тип Описание
id int Идентификатор пользовательского поля.
title string Название пользовательского поля на текущем языке.
type string Тип поля. Доступные значения: string, int, float, date, datetime, bool, select, multiselect.
essence string Сущность, у которой используется поле. Доступные значения: leads, orders.
params array<object> Параметры поля. Для типов select и multiselect хранит список вариантов для выбора, включая скрытые (удалённые). Для остальных типов — пустой массив.
sort int Порядок сортировки поля.
defaultValue mixed \| null Значение по умолчанию, которое проставляется при создании Лида или Заказа. Формат — как у значения поля (см. раздел «Значения пользовательских полей» ниже). null — значения по умолчанию нет.
allowEmpty bool Можно ли очистить значение поля (сохранить пустое значение).
showAlways bool Показывать поле в карточке Лида или Заказа всегда, даже если у него нет значения.
apiOnly bool Значение поля можно изменить только через API — не из карточки и не правилами обработки.

Поля в params

Поле Тип Описание
code string Код параметра (варианта) для выбора. Именно код передаётся и возвращается как значение поля.
sort int Порядок сортировки параметра.
title string Название параметра (варианта) для выбора на текущем языке.
isDeleted bool Вариант скрыт (удалён). Выбрать его нельзя, но у сущностей, где он уже выбран, он остаётся.

Примечание

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


Значения пользовательских полей

Значения пользовательских полей Лидов и Заказов передаются и возвращаются в поле customValues — словаре, где ключ — ID пользовательского поля (id), значение — значение этого поля.

Тип поля Значение при записи Значение в ответе
string Строка. Строка.
int Целое число или строка из цифр. Строка, например "10".
float Число или числовая строка. Строка, например "10.5".
bool true / false или строки "true" / "false". Строка "true" / "false".
date Строка YYYY-MM-DD в часовом поясе инстанса Лайнера. Строка YYYY-MM-DD HH:MM:SS в UTC — полночь даты в часовом поясе инстанса.
datetime Строка YYYY-MM-DDTHH:MM в часовом поясе инстанса Лайнера. Строка YYYY-MM-DD HH:MM:SS в UTC.
select Код варианта (params[].code). Код варианта.
multiselect Массив кодов вариантов. Массив кодов вариантов.

Правила записи:

  • Значения сохраняются по каждому полю отдельно. Невалидное значение (неизвестное поле, поле другой сущности, значение не того типа, неизвестный или скрытый код варианта, пустое значение у поля с allowEmpty: false) не приводит к ошибке — оно пропускается, а остальные поля и сам Лид/Заказ сохраняются.
  • Чтобы очистить поле, передайте null, "" или []. Работает только у полей с allowEmpty: true.
  • Скрытый (удалённый) вариант выбрать нельзя, но если он уже выбран у сущности — его можно оставить.
  • При создании Лида или Заказа полям с defaultValue проставляется значение по умолчанию; значения из запроса его перезаписывают.