Получить параметры поля или список полей универсального списка lists.field.get

Scope: lists

Кто может выполнять метод: пользователь с правом «Чтение» для нужного списка

Метод lists.field.get возвращает данные о поле или список полей.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
IBLOCK_TYPE_ID* `string`	Идентификатор типа инфоблока. Возможные значения: `lists` — тип инфоблока списка `bitrix_processes` — тип инфоблока процессов `lists_socnet` — тип инфоблока списков групп Идентификатор можно получить с помощью метода lists.get.iblock.type.id
IBLOCK_ID* `integer`	Идентификатор инфоблока. Идентификатор можно получить с помощью метода lists.get
IBLOCK_CODE* `string`	Cимвольный код инфоблока. Код можно получить с помощью метода lists.get Необходимо указать хотя бы один из параметров: `IBLOCK_ID` или `IBLOCK_CODE`
FIELD_ID `string`	Идентификатор поля. Для пользовательского поля имеет вид `PROPERTY_PropertyId`. Для системного поля является его символьным кодом. Если не указать, возвращаются все поля списка

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":"123","FIELD_ID":"PROPERTY_1151"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.field.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":"123","FIELD_ID":"PROPERTY_1151","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.field.get

try
        {
            const response = await $b24.callMethod(
                'lists.field.get',
                {
                    IBLOCK_TYPE_ID: 'lists',
                    IBLOCK_ID: '123',
                    FIELD_ID: 'PROPERTY_1151',
                }
            );
            
            const result = response.getData().result;
            console.log('Fetched field data:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'lists.field.get',
                    [
                        'IBLOCK_TYPE_ID' => 'lists',
                        'IBLOCK_ID' => '123',
                        'FIELD_ID' => 'PROPERTY_1151'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching field: ' . $e->getMessage();
        }

BX24.callMethod(
            'lists.field.get',
            {
                'IBLOCK_TYPE_ID': 'lists', 
                'IBLOCK_ID': '123',        
                'FIELD_ID': 'PROPERTY_1151'
            },
            function(result) { 
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'lists.field.get',
            [
                'IBLOCK_TYPE_ID' => 'lists',
                'IBLOCK_ID' => '123',
                'FIELD_ID' => 'PROPERTY_1151'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "L": {
                "FIELD_ID": "PROPERTY_1151",
                "SORT": 50,
                "NAME": "Статус задачи",
                "IS_REQUIRED": "N",
                "MULTIPLE": "N",
                "DEFAULT_VALUE": "1685",
                "TYPE": "L",
                "PROPERTY_TYPE": "L",
                "PROPERTY_USER_TYPE": false,
                "CODE": "PROJECT",
                "ID": "1151",
                "LINK_IBLOCK_ID": null,
                "ROW_COUNT": "1",
                "COL_COUNT": "30",
                "USER_TYPE_SETTINGS": null,
                "SETTINGS": {
                    "SHOW_ADD_FORM": "Y",
                    "SHOW_EDIT_FORM": "Y",
                    "ADD_READ_ONLY_FIELD": "N",
                    "EDIT_READ_ONLY_FIELD": "Y",
                    "SHOW_FIELD_PREVIEW": "N"
                },
                "DISPLAY_VALUES_FORM": {
                    "1669": "Планирование",
                    "1671": "В активной работе",
                    "1673": "Тестирование",
                    "1675": "Завершен",
                    "1677": "Отложен",
                    "1679": "Архив"
                }
                }
            },
            "time": {
                "start": 1765375929,
                "finish": 1765375929.696936,
                "duration": 0.6969358921051025,
                "processing": 0,
                "date_start": "2025-12-10T12:12:09+03:00",
                "date_finish": "2025-12-10T12:12:09+03:00",
                "operating_reset_at": 1765376529,
                "operating": 0
            }
            }

Возвращаемые данные

Название
тип

Описание

result
array

Данные поля или массив полей.

Пустой массив означает, что в списке нет полей с указанным FIELD_ID

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error":"ERROR_REQUIRED_PARAMETERS_MISSING",
            "error_description":"Required parameter `X` is missing"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`ERROR_REQUIRED_PARAMETERS_MISSING`	Required parameter `X` is missing	Обязательный параметр не передан
`ERROR_IBLOCK_NOT_FOUND`	Iblock not found	Инфоблок не найден
`ACCESS_DENIED`	Access denied	Недостаточно прав для чтения

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Изменить поле списка

Удалить поле

Получить параметры поля или список полей универсального списка lists.field.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение