Получить список пользовательских полей user.userfield.list

Scope: user.userfield

Кто может выполнять метод: администратор

Метод user.userfield.list получает список пользовательских полей по фильтру.

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

Название
тип

Описание

order
string|array

Сортировка выбранных пользовательских полей в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field_N:

ID — идентификатор пользовательского поля
FIELD_NAME — название поля
USER_TYPE_ID — тип данных поля
XML_ID — внешний код
SORT — порядок сортировки поля
MULTIPLE — возможность ввода нескольких значений
MANDATORY — обязательность заполнения
SHOW_FILTER — показ поля в фильтре списка пользователей
SHOW_IN_LIST — показ поля в списке пользователей
EDIT_IN_LIST — возможность редактирования поля в списке пользователей
IS_SEARCHABLE — возможность поиска по полю

Возможные значения для order_N:

asc — в порядке возрастания
desc — в порядке убывания

filter
array

Фильтр выбранных пользовательских полей в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field_N аналогичны полям в сортировке.

Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

>= — больше либо равно
> — больше
<= — меньше либо равно
< — меньше
@ — IN (в качестве значения передается массив)
!@ — NOT IN (в качестве значения передается массив)
% — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки.
=% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищем значения начинающиеся с «мол»
- "%мол" — ищем значения заканчивающиеся на «мол»
- "%мол%" — ищем значения, где «мол» может быть в любой позиции
%= — LIKE (аналогично =%)
!% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
!=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищем значения не начинающиеся с «мол»
- "%мол" — ищем значения не заканчивающиеся на «мол»
- "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
!%= — NOT LIKE (аналогично !=%)
= — равно, точное совпадение (используется по умолчанию)
!= — не равно
! — не равно

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"id":"desc"},"filter":{"id":13}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.userfield.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"id":"desc"},"filter":{"id":13},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/user.userfield.list

// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'user.userfield.list',
            {
              order: {
                id: 'desc',
              },
              filter: {
                id: 13
              },
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
          const generator = $b24.fetchListMethod('user.userfield.list', {
            order: {
              id: 'desc',
            },
            filter: {
              id: 13
            },
          }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
          const response = await $b24.callMethod('user.userfield.list', {
            order: {
              id: 'desc',
            },
            filter: {
              id: 13
            },
          }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'user.userfield.list',
                    [
                        'order' => [
                            'id' => 'desc',
                        ],
                        'filter' => [
                            'id' => 13
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching user fields: ' . $e->getMessage();
        }

BX24.callMethod(
            "user.userfield.list",
            {
                order: {
                    id: 'desc',
                },
                filter: {
                    id: 13
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'user.userfield.list',
            [
                'order' => [
                    'id' => 'desc',
                ]
                'filter' => [
                    'id' => 13,
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result":[
                {
                    "ID":"176",
                    "ENTITY_ID":"USER",
                    "FIELD_NAME":"UF_USR_1724228142162",
                    "USER_TYPE_ID":"enumeration",
                    "XML_ID":null,
                    "SORT":"100",
                    "MULTIPLE":"Y",
                    "MANDATORY":"N",
                    "SHOW_FILTER":"E",
                    "SHOW_IN_LIST":"Y",
                    "EDIT_IN_LIST":"Y",
                    "IS_SEARCHABLE":"N",
                    "SETTINGS":{
                        "DISPLAY":"UI",
                        "LIST_HEIGHT":1,
                        "CAPTION_NO_VALUE":"",
                        "SHOW_NO_VALUE":"Y"
                    },
                    "LIST":[
                        {
                            "ID":"26",
                            "SORT":"0",
                            "VALUE":"1",
                            "DEF":"N",
                            "XML_ID":"2a53ce08b86a6aba152b1b19204fdef2"
                        },
                        {
                            "ID":"27",
                            "SORT":"100",
                            "VALUE":"2",
                            "DEF":"N",
                            "XML_ID":"292df2be1171ed6ab038996deac29ac8"
                        },
                        {
                            "ID":"28",
                            "SORT":"200",
                            "VALUE":"3",
                            "DEF":"N",
                            "XML_ID":"3c5af70eafbba79a6cf52e299ed75123"
                        }
                    ]
                },
                {
                    "ID":"177",
                    "ENTITY_ID":"USER",
                    "FIELD_NAME":"UF_USR_MONEY",
                    "USER_TYPE_ID":"money",
                    "XML_ID":null,
                    "SORT":"100",
                    "MULTIPLE":"N",
                    "MANDATORY":"N",
                    "SHOW_FILTER":"N",
                    "SHOW_IN_LIST":"Y",
                    "EDIT_IN_LIST":"Y",
                    "IS_SEARCHABLE":"N",
                    "SETTINGS":{
                        "DEFAULT_VALUE":""
                    }
                }
            ],
            "total":2,
            "time":{
                "start":1747313326.788124,
                "finish":1747313328.641663,
                "duration":1.853538990020752,
                "processing":0.011211156845092773,
                "date_start":"2025-05-15T14:48:46+02:00",
                "date_finish":"2025-05-15T14:48:48+02:00",
                "operating":0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
total `integer`	Общее количество найденных записей
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{	
           "error":"",
           "error_description":"Access denied."
        }

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

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

Код	Описание	Значение
Пустая строка	Access denied.	Поле с таким `id` не существует или доступ запрещен
Пустая строка	ID is not defined or invalid	Не задан или введен неверный `id`

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

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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

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

Обновить пользовательское поле

Получить список пользовательских полей user.userfield.list

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

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

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

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

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

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

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

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