Получить список пользовательских полей task.item.userfield.getlist

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: любой пользователь

Метод task.item.userfield.getlist получает список пользовательских полей задач.

В списке будет три системных поля задач для связи с другими объектами:

UF_CRM_TASK — с объектами CRM
UF_MAIL_MESSAGE — с письмом Почты
UF_TASK_WEBDAV_FILES — c файлами Диска

Они созданы на основе пользовательских полей, поэтому есть в списке. Подробнее о связях задачи с другими объектами — в статье Задачи: обзор методов.

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

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

Название
тип

Описание

ORDER
object

Объект для сортировки результата вида {"поле": "значение сортировки", ... }.

Сортировать можно по полям:

ID — идентификатор пользовательского поля
FIELD_NAME — код пользовательского поля
USER_TYPE_ID — тип пользовательского поля
SORT — значение сортировки

Направление сортировки может принимать значения:

asc — по возрастанию
desc — по убыванию

FILTER
object

Объект для фильтрации результата вида {"поле": "значение фильтра", ... }. Значением фильтруемого поля может быть одиночное значение или массив значений.

Фильтровать можно по полям:

ID — идентификатор пользовательского поля
FIELD_NAME — код пользовательского поля
USER_TYPE_ID — тип пользовательского поля
XML_ID — внешний идентификатор
MULTIPLE — множественное, Yили N
MANDATORY — обязательное, Y или N

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ORDER": {
            "SORT": "ASC"
          }
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.getlist

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ORDER": {
            "SORT": "ASC"
          },
          "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/task.item.userfield.getlist

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type UserFieldItem = {
          ID: string
          ENTITY_ID: string
          FIELD_NAME: string
          USER_TYPE_ID: string
          XML_ID: string
          SORT: string
          MULTIPLE: string
          MANDATORY: string
          SHOW_FILTER: string
          SHOW_IN_LIST: string
          EDIT_IN_LIST: string
          IS_SEARCHABLE: string
          SETTINGS: Record<string, unknown>
        }
        
        try {
          // task.item.userfield.getlist returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<UserFieldItem[]>({
            method: 'task.item.userfield.getlist',
            params: {
              ORDER: {
                SORT: 'ASC',
              },
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('User fields count:', result.length, result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getUserFields() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // task.item.userfield.getlist returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'task.item.userfield.getlist',
                params: {
                  ORDER: {
                    SORT: 'ASC',
                  },
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('User fields count:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getUserFields)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'task.item.userfield.getlist',
                    [
                        'ORDER' => [
                            'SORT' => 'ASC'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'task.item.userfield.getlist',
            {
                ORDER: {
                    SORT: 'ASC'
                },
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'task.item.userfield.getlist',
            [
                'ORDER' => [
                    'SORT' => 'ASC'
                ]
            ]
        );
        
        print_r($result);

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

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "1295",
                    "ENTITY_ID": "TASKS_TASK",
                    "FIELD_NAME": "UF_CRM_TASK",
                    "USER_TYPE_ID": "crm",
                    "XML_ID": "",
                    "SORT": "100",
                    "MULTIPLE": "Y",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "N",
                    "EDIT_IN_LIST": "N",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": {
                        "LEAD": "Y",
                        "CONTACT": "Y",
                        "COMPANY": "Y",
                        "DEAL": "Y"
                    }
                },
                {
                    "ID": "662",
                    "ENTITY_ID": "TASKS_TASK",
                    "FIELD_NAME": "UF_MAIL_MESSAGE",
                    "USER_TYPE_ID": "mail_message",
                    "XML_ID": "",
                    "SORT": "100",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "N",
                    "EDIT_IN_LIST": "N",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": []
                },
                {
                    "ID": "229",
                    "ENTITY_ID": "TASKS_TASK",
                    "FIELD_NAME": "UF_TASK_WEBDAV_FILES",
                    "USER_TYPE_ID": "disk_file",
                    "XML_ID": "TASK_WEBDAV_FILES",
                    "SORT": "100",
                    "MULTIPLE": "Y",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "Y",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "Y",
                    "SETTINGS": {
                        "IBLOCK_ID": 0,
                        "SECTION_ID": 0,
                        "UF_TO_SAVE_ALLOW_EDIT": ""
                    }
                },
                {
                    "ID": "1325",
                    "ENTITY_ID": "TASKS_TASK",
                    "FIELD_NAME": "UF_TASK_CLIENT_REQUEST",
                    "USER_TYPE_ID": "string",
                    "XML_ID": "UF_TASK_CLIENT_REQUEST",
                    "SORT": "220",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "Y",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": {
                        "SIZE": 20,
                        "ROWS": 10,
                        "REGEXP": "",
                        "MIN_LENGTH": 0,
                        "MAX_LENGTH": 0,
                        "DEFAULT_VALUE": "Уточнить цель и ожидаемый результат"
                    }
                },
                {
                    "ID": "1333",
                    "ENTITY_ID": "TASKS_TASK",
                    "FIELD_NAME": "UF_TASK_PROJECT_BUDGET",
                    "USER_TYPE_ID": "double",
                    "XML_ID": "UF_TASK_PROJECT_BUDGET",
                    "SORT": "230",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "Y",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": {
                        "PRECISION": 0,
                        "SIZE": 20,
                        "MIN_VALUE": 0,
                        "MAX_VALUE": 0,
                        "DEFAULT_VALUE": 0
                    }
                },
                {
                    "ID": "1335",
                    "ENTITY_ID": "TASKS_TASK",
                    "FIELD_NAME": "UF_TASK_APPROVAL_DEADLINE",
                    "USER_TYPE_ID": "datetime",
                    "XML_ID": "UF_TASK_APPROVAL_DEADLINE",
                    "SORT": "240",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "Y",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": {
                        "DEFAULT_VALUE": {
                            "TYPE": "NONE",
                            "VALUE": ""
                        },
                        "USE_SECOND": "Y",
                        "USE_TIMEZONE": "N"
                    }
                },
                {
                    "ID": "1337",
                    "ENTITY_ID": "TASKS_TASK",
                    "FIELD_NAME": "UF_TASK_LEGAL_REVIEW_REQUIRED",
                    "USER_TYPE_ID": "boolean",
                    "XML_ID": "UF_TASK_LEGAL_REVIEW_REQUIRED",
                    "SORT": "250",
                    "MULTIPLE": "N",
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SHOW_IN_LIST": "Y",
                    "EDIT_IN_LIST": "Y",
                    "IS_SEARCHABLE": "N",
                    "SETTINGS": {
                        "DEFAULT_VALUE": 0,
                        "DISPLAY": "CHECKBOX",
                        "LABEL": ["", ""],
                        "LABEL_CHECKBOX": ""
                    }
                }
            ],
            "total": 0,
            "time": {
                "start": 1772718556,
                "finish": 1772718556.080225,
                "duration": 0.08022499084472656,
                "processing": 0,
                "date_start": "2026-03-05T16:49:16+03:00",
                "date_finish": "2026-03-05T16:49:16+03:00",
                "operating_reset_at": 1772719156,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `array`	Массив объектов пользовательских полей (подробное описание)
total `integer`	Сейчас возвращает `0`
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
ID `integer`	Идентификатор пользовательского поля
ENTITY_ID `string`	Код объекта, к которому привязано поле
FIELD_NAME `string`	Код пользовательского поля
USER_TYPE_ID `string`	Тип данных
XML_ID `string`	Внешний идентификатор
SORT `integer`	Значение сортировки
MULTIPLE `char`	Признак множественного значения. Возможные значения: `Y` — множественное `N` — единственное
MANDATORY `char`	Признак обязательного поля. Возможные значения: `Y` — обязательное `N` — не обязательное
SHOW_FILTER `char`	Показ в фильтре списка
SHOW_IN_LIST `char`	Показ в списке
EDIT_IN_LIST `char`	Разрешено редактирование в списке
IS_SEARCHABLE `char`	Значение участвует в поиске
SETTINGS `object`	Дополнительные настройки поля, состав зависит от типа `USER_TYPE_ID`

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

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

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

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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Получить пользовательское поле по id

Удалить пользовательское поле

Получить список пользовательских полей task.item.userfield.getlist

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

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

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

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

Объект resultОбъект result

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

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

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