Получить список настроек пользовательских полей userfieldconfig.list

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

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

Scope: userfieldconfig, scope модуля из moduleId (например, crm)

Кто может выполнять метод: пользователь с правом чтения объекта, которому принадлежат поля, в модуле moduleId

Метод userfieldconfig.list возвращает список настроек пользовательских полей по фильтру.

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

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

Название
тип

Описание

moduleId*
string

Идентификатор модуля, в котором выполняется поиск полей

select
object

Набор полей, которые нужно вернуть (подробное описание)

order
object

Объект формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n,
}
  • field_n - название поля, по которому будет произведена сортировка выборки
  • value_n - значение типа string, равное:
    • ASC - сортировка по возрастанию
    • DESC - сортировка по убыванию

Список доступных полей для сортировки:

  • id - идентификатор пользовательского поля
  • fieldName - код пользовательского поля
  • userTypeId - тип пользовательского поля
  • xmlId - внешний код
  • sort - индекс сортировки

По умолчанию:

{
    "sort": "ASC",
    "id": "ASC"
}

filter
object

Объект формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n,
}
  • field_n - название поля, по которому будет отфильтрована выборка пользовательских полей
  • value_n - значение фильтра

Все условия по отдельным полям соединяются с помощью AND.

Смотрите ниже список доступных полей для фильтрации

start
integer

Смещение для постраничной выборки.

Используйте значение параметра next из предыдущего ответа

Параметр select

Название
тип

Описание

*
string

Вернуть все стандартные поля настройки

language
string

Языковой идентификатор для языковых полей, например ru или en

id
string

Идентификатор настройки поля

entityId
string

Идентификатор объекта

fieldName
string

Код поля

userTypeId
string

Тип поля

xmlId
string

Внешний идентификатор

sort
string

Индекс сортировки

multiple
string

Является ли пользовательское поле множественным. Возможные значения: Y или N

mandatory
string

Является ли пользовательское поле обязательным. Возможные значения: Y или N

showFilter
string

Показывать ли поле в фильтре списка. Возможные значения: N, I, E, S

showInList
string

Показывать ли поле в списке. Возможные значения: Y или N

editInList
string

Разрешать ли редактирование значения в списке. Возможные значения: Y или N

isSearchable
string

Участвуют ли значения поля в поиске. Возможные значения: Y или N

settings
string

Дополнительные настройки поля

languageId
string

Языковой идентификатор. При передаче этого параметра возвращается набор языковых полей на выбранном языке:

  • editFormLabel - подпись в форме редактирования
  • listColumnLabel - заголовок в списке
  • listFilterLabel - подпись фильтра в списке
  • errorMessage - сообщение об ошибке
  • helpMessage - помощь

Доступные для фильтрации поля

Название
тип

Описание

id
integer

Идентификатор пользовательского поля

fieldName
string

Код пользовательского поля

userTypeId
string

Тип пользовательского поля

xmlId
string

Внешний код

sort
integer

Индекс сортировки

multiple
boolean

Является ли пользовательское поле множественным. Возможные значения: Y или N

mandatory
boolean

Является ли пользовательское поле обязательным. Возможные значения: Y или N

showFilter
char

Показывать ли в фильтре списка. Возможные значения: N, I, E, S

showInList
boolean

Показывать ли в списке. Возможные значения: Y или N

editInList
boolean

Разрешать ли редактирование пользователем. Возможные значения: Y или N

isSearchable
boolean

Участвуют ли значения поля в поиске. Возможные значения: Y или N

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"moduleId":"crm","select":{"0":"*","language":"ru"},"order":{"id":"DESC"},"filter":{"multiple":"Y"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldconfig.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"moduleId":"crm","select":{"0":"*","language":"ru"},"order":{"id":"DESC"},"filter":{"multiple":"Y"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/userfieldconfig.list
// 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 UserFieldConfig = {
  id: string
  fieldName: string
  userTypeId: string
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type UserFieldConfigListResult = {
  fields: UserFieldConfig[]
}

// userfieldconfig.list 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.
try {
  const response = await $b24.actions.v2.call.make<UserFieldConfigListResult>({
    method: 'userfieldconfig.list',
    params: {
      moduleId: 'crm',
      select: ['*'],
      order: {
        id: 'DESC',
      },
      filter: {
        multiple: 'Y',
      },
      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(`Loaded ${result.fields.length} field config(s) on this page`)
    console.info(result.fields)
  }
} 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 listUserFieldConfigs() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // userfieldconfig.list 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: 'userfieldconfig.list',
        params: {
          moduleId: 'crm',
          select: ['*'],
          order: {
            id: 'DESC',
          },
          filter: {
            multiple: 'Y',
          },
          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(`Loaded ${result.fields.length} field config(s) on this page`)
      console.info(result.fields)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listUserFieldConfigs)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.userfieldconfig.list(
        module_id="crm",
        select={
            0: "*",
            "language": "ru",
        },
        order={
            "id": "DESC",
        },
        filter={
            "multiple": "Y",
        },
        start=0,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'userfieldconfig.list',
            [
                'moduleId' => 'crm',
                'select' => [
                    0 => '*',
                    'language' => 'ru',
                ],
                'order' => [
                    'id' => 'DESC',
                ],
                'filter' => [
                    'multiple' => 'Y',
                ],
                'start' => 0,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Result: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
    'userfieldconfig.list',
    {
        moduleId: 'crm',
        select: {
            0: '*',
            language: 'ru',
        },
        order: {
            id: 'DESC',
        },
        filter: {
            multiple: 'Y',
        },
    },
    (result) => {
        if (result.error()) {
            console.error(result.error());
            return;
        }

        console.info(result.data());

        if (result.more()) {
            result.next();
        }
    },
);
require_once('crest.php');

$result = CRest::call(
    'userfieldconfig.list',
    [
        'moduleId' => 'crm',
        'select' => [
            0 => '*',
            'language' => 'ru',
        ],
        'order' => [
            'id' => 'DESC',
        ],
        'filter' => [
            'multiple' => 'Y',
        ],
        'start' => 0,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "userfieldconfig.list", b24.Params{
	"moduleId": "crm",
	"select": b24.Params{
		"0":        "*",
		"language": "ru",
	},
	"order": b24.Params{
		"id": "DESC",
	},
	"filter": b24.Params{
		"multiple": "Y",
	},
	"start": 0,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("userfieldconfig.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "fields".
raw, ok := b24.Unwrap(res.Result, "fields")
if !ok {
	return fmt.Errorf("в ответе нет ключа fields")
}

var items []struct {
	ID         b24.ID `json:"id"`
	EntityID   string `json:"entityId"`
	FieldName  string `json:"fieldName"`
	UserTypeID string `json:"userTypeId"`
	Sort       string `json:"sort"`
	Multiple   string `json:"multiple"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID)
}

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

HTTP-статус: 200

{
    "result": {
        "fields": [
            {
                "id": "7095",
                "entityId": "CRM_7",
                "fieldName": "UF_CRM_7_NEW_REST_LIST_2026",
                "userTypeId": "enumeration",
                "xmlId": null,
                "sort": "100",
                "multiple": "Y",
                "mandatory": "N",
                "showFilter": "N",
                "showInList": "Y",
                "editInList": "Y",
                "isSearchable": "N",
                "settings": {
                    "DISPLAY": "LIST",
                    "LIST_HEIGHT": 1,
                    "CAPTION_NO_VALUE": "",
                    "SHOW_NO_VALUE": "Y"
                },
                "languageId": {
                    "ru": "ru"
                },
                "editFormLabel": {
                    "ru": "Список характеристик"
                },
                "listColumnLabel": null,
                "listFilterLabel": null,
                "errorMessage": null,
                "helpMessage": null
            }
        ]
    },
    "next": 50,
    "total": 94,
    "time": {
        "start": 1724239307.903115,
        "finish": 1724239308.567422,
        "duration": 0.6643068790435791,
        "processing": 0.20090818405151367,
        "date_start": "2024-08-21T13:21:47+02:00",
        "date_finish": "2024-08-21T13:21:48+02:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Корневой элемент ответа (подробное описание)

total
integer

Общее количество найденных настроек

next
integer

Смещение следующей страницы.

Поле возвращается, если количество найденных элементов больше 50

time
time

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

Объект result

Название
тип

Описание

fields
object[]

Список найденных настроек пользовательских полей (подробное описание)

Объект fields[]

Название
тип

Описание

id
integer

Идентификатор пользовательского поля

entityId
string

Идентификатор объекта, к которому относится пользовательское поле

fieldName
string

Код пользовательского поля

userTypeId
string

Тип пользовательского поля

xmlId
string

Внешний код

sort
integer

Индекс сортировки

multiple
boolean

Является ли пользовательское поле множественным. Возможные значения: Y или N

mandatory
boolean

Является ли пользовательское поле обязательным. Возможные значения: Y или N

showFilter
char

Режим отображения в фильтре.

Возможные значения: N, I, E, S

showInList
boolean

Показывать ли поле в списке. Возможные значения: Y или N

editInList
boolean

Разрешать ли редактирование значения в списке. Возможные значения: Y или N

isSearchable
boolean

Участвуют ли значения поля в поиске. Возможные значения: Y или N

settings
object

Дополнительные настройки поля.

Состав ключей зависит от userTypeId

languageId
object

Языковые идентификаторы, для которых заданы подписи

editFormLabel
lang_map

Подписи в форме редактирования

listColumnLabel
lang_map

Заголовок в списке

listFilterLabel
lang_map

Подпись фильтра в списке

errorMessage
lang_map

Сообщение об ошибке

helpMessage
lang_map

Подсказка

enum
object[]

Элементы списка для userTypeId = enumeration.

Поле может отсутствовать для других типов

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Вы не можете просматривать настройки пользовательских полей"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Код

Описание

Значение

Пустое значение

Вы не можете просматривать настройки пользовательских полей

Недостаточно прав на чтение полей по переданному фильтру

Пустое значение

The current method required more scopes. (crm)

У приложения нет нужного scope для модуля из moduleId

Пустое значение

No settings for UserFieldAccess

Для переданного moduleId не настроен доступ к пользовательским полям

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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