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

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

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

Примечание

Не реализует пагинацию — возвращается весь список пользовательских полей.

Адрес и метод

GET /v2/custom-field/

Параметры

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

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

curl -X GET "https://YOUR_LINER_API_HOST/v2/custom-fields/?essence=orders" \
  -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
]);

$ch = curl_init($host . '/v2/custom-fields/?' . $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

const res = await fetch(`${host}/v2/custom-fields/?${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": [
    {
      "id": "{{id}}",
      "title": "{{title}}",
      "type": "{{type}}",
      "essence": "{{essence}}",
      "params": [
        {
          "code": "{{params.code}}",
          "sort": "{{params.sort}}",
          "title": "{{params.title}}"
        }
      ],
      "sort": "{{sort}}"
    }
  ]
}

Поля ответа

Поля в data

Поле Тип Описание
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 Порядок сортировки поля.

Поля в params

Поле Тип Описание
code string Код параметра (варианта) для выбора.
sort int Порядок сортировки параметра.
title string Название параметра (варианта) для выбора.

Примечание

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