метод REST scope: lists

lists.field.get

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

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

Описание

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

Параметры

IBLOCK_TYPE_ID string обязательный

Идентификатор типа инфоблока.

Стандартные типы:
- lists — универсальные списки
- bitrix_processes — процессы
- lists_socnet — списки групп

В коробочной версии можно также указать идентификатор произвольного существующего типа инфоблоков. IBLOCK_ID или IBLOCK_CODE должен указывать на инфоблок этого типа. Доступ к операции определяется стандартными правами пользователя на инфоблок, раздел или элемент

Идентификатор можно получить с помощью метода 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 -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

Ответ

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_REQUIRED_PARAMETERS_MISSING Required parameter X is missing Обязательный параметр не передан
ERROR_IBLOCK_NOT_FOUND Iblock not found Инфоблок не найден
ACCESS_DENIED Access denied Недостаточно прав для чтения

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.