Получить список пользовательских полей контактов crm.contact.userfield.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: администратор
Метод crm.contact.userfield.list возвращает список пользовательских полей контактов по фильтру.
Выводится и информация об этих полях, но без названия, которое присвоил полю пользователь, только внутренний идентификатор. Если нужно пользовательское название поля, воспользуйтесь методом crm.contact.list, который выводит как стандартные поля, так и пользовательские.
Параметры метода
|
Название |
Описание |
|
filter |
Объект формата:
где:
Все условия по отдельным полям соединяются с помощью |
|
order |
Объект формата:
где:
Список доступных полей для сортировки:
По умолчанию:
|
Доступные для фильтрации поля
|
Название |
Описание |
|
ID |
Идентификатор пользовательского поля |
|
FIELD_NAME |
Код пользовательского поля |
|
USER_TYPE_ID |
Тип пользовательского поля. Возможные значения:
|
|
XML_ID |
Внешний код |
|
SORT |
Индекс сортировки |
|
MULTIPLE |
Является ли пользовательское поле множественным ( |
|
MANDATORY |
Является ли пользовательское поле обязательным ( |
|
SHOW_FILTER |
Показывать ли в фильтре списка. Возможные значения:
|
|
SHOW_IN_LIST |
Показывать ли в списке ( Данный параметр ни на что не влияет в рамках |
|
EDIT_IN_LIST |
Разрешать ли редактирование пользователем ( |
|
IS_SEARCHABLE |
Участвуют ли значения поля в поиске ( Данный параметр ни на что не влияет в рамках |
|
LANG |
Языковой идентификатор. При фильтрации по данному параметру будет предоставлен набор полей со значениями на переданном языке:
|
Примеры кода
Как использовать примеры в документации
Получить список пользовательских полей, которые:
- являются множественными
- являются обязательными
- имеют подписи пользовательского поля на русском языке
Задать следующий порядок сортировки у данной выборки: тип поля и индекс сортировки по возрастанию.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"MULTIPLE":"Y","MANDATORY":"Y","LANG":"ru"},"order":{"USER_TYPE_ID":"ASC","SORT":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.userfield.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"MULTIPLE":"Y","MANDATORY":"Y","LANG":"ru"},"order":{"USER_TYPE_ID":"ASC","SORT":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.contact.userfield.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
// Shape of each userfield object returned in result[]
type CrmContactUserfieldListItem = {
ID: string
ENTITY_ID: string
FIELD_NAME: string
USER_TYPE_ID: string
XML_ID: string | null
SORT: string
MULTIPLE: string
MANDATORY: string
EDIT_FORM_LABEL: string
LIST_COLUMN_LABEL: string
}
try {
// crm.contact.userfield.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<CrmContactUserfieldListItem[]>({
method: 'crm.contact.userfield.list',
params: {
filter: {
MULTIPLE: 'Y',
MANDATORY: 'Y',
LANG: 'ru',
},
order: {
USER_TYPE_ID: 'ASC',
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('Userfields on this page:', 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 listContactUserfields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.contact.userfield.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: 'crm.contact.userfield.list',
params: {
filter: {
MULTIPLE: 'Y',
MANDATORY: 'Y',
LANG: 'ru',
},
order: {
USER_TYPE_ID: 'ASC',
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('Userfields on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listContactUserfields)
</script>
try {
$response = $b24Service
->core
->call(
'crm.contact.userfield.list',
[
'filter' => [
'MULTIPLE' => 'Y',
'MANDATORY' => 'Y',
'LANG' => 'ru',
],
'order' => [
'USER_TYPE_ID' => 'ASC',
'SORT' => 'ASC',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching user fields: ' . $e->getMessage();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.contact.userfield.list(
filter={
"MULTIPLE": "Y",
"MANDATORY": "Y",
"LANG": "ru",
},
order={
"USER_TYPE_ID": "ASC",
"SORT": "ASC",
},
).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}")
Пример as_list
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.contact.userfield.list(
filter={
"MULTIPLE": "Y",
"MANDATORY": "Y",
"LANG": "ru",
},
order={"ID": "ASC"},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
Пример as_list_fast
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.contact.userfield.list(
filter={
"MULTIPLE": "Y",
"MANDATORY": "Y",
"LANG": "ru",
},
order={"ID": "DESC"},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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}")
BX24.callMethod(
'crm.contact.userfield.list',
{
filter: {
MULTIPLE: "Y",
MANDATORY: "Y",
LANG: "ru",
},
order: {
USER_TYPE_ID: "ASC",
SORT: "ASC",
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.contact.userfield.list',
[
'filter' => [
'MULTIPLE' => "Y",
'MANDATORY' => "Y",
'LANG' => "ru",
],
'order' => [
'USER_TYPE_ID' => "ASC",
'SORT' => "ASC",
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "474",
"ENTITY_ID": "CRM_CONTACT",
"FIELD_NAME": "UF_CRM_1724412832",
"USER_TYPE_ID": "address",
"XML_ID": null,
"SORT": "300",
"MULTIPLE": "Y",
"MANDATORY": "Y",
"SHOW_FILTER": "E",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SHOW_MAP": "Y"
},
"EDIT_FORM_LABEL": "Пользовательское поле (Адрес)",
"LIST_COLUMN_LABEL": "Пользовательское поле (Адрес)",
"LIST_FILTER_LABEL": "Пользовательское поле (Адрес)",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null
},
{
"ID": "475",
"ENTITY_ID": "CRM_CONTACT",
"FIELD_NAME": "UF_CRM_1724412867",
"USER_TYPE_ID": "crm",
"XML_ID": null,
"SORT": "1400",
"MULTIPLE": "Y",
"MANDATORY": "Y",
"SHOW_FILTER": "I",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"CONTACT": "Y",
"COMPANY": "Y",
"DYNAMIC_1224": "Y",
"DYNAMIC_1226": "Y",
"DYNAMIC_1268": "Y",
"DYNAMIC_1278": "Y",
"LEAD": null
},
"EDIT_FORM_LABEL": "Пользовательское поле (Привязка к элементам CRM))",
"LIST_COLUMN_LABEL": "Пользовательское поле (Привязка к элементам CRM))",
"LIST_FILTER_LABEL": "Пользовательское поле (Привязка к элементам CRM))",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null
},
{
"ID": "472",
"ENTITY_ID": "CRM_CONTACT",
"FIELD_NAME": "UF_CRM_1724412764",
"USER_TYPE_ID": "date",
"XML_ID": null,
"SORT": "2000",
"MULTIPLE": "Y",
"MANDATORY": "Y",
"SHOW_FILTER": "E",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"DEFAULT_VALUE": {
"VALUE": "2024-08-22",
"TYPE": "FIXED"
}
},
"EDIT_FORM_LABEL": "Пользовательское поле (Дата)",
"LIST_COLUMN_LABEL": "Пользовательское поле (Дата)",
"LIST_FILTER_LABEL": "Пользовательское поле (Дата)",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null
},
{
"ID": "471",
"ENTITY_ID": "CRM_CONTACT",
"FIELD_NAME": "UF_CRM_1724412713",
"USER_TYPE_ID": "double",
"XML_ID": null,
"SORT": "1500",
"MULTIPLE": "Y",
"MANDATORY": "Y",
"SHOW_FILTER": "E",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"PRECISION": 2,
"SIZE": 20,
"MIN_VALUE": 0,
"MAX_VALUE": 0,
"DEFAULT_VALUE": 150
},
"EDIT_FORM_LABEL": "Пользовательское поле (число)",
"LIST_COLUMN_LABEL": "Пользовательское поле (число)",
"LIST_FILTER_LABEL": "Пользовательское поле (число)",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null
},
{
"ID": "473",
"ENTITY_ID": "CRM_CONTACT",
"FIELD_NAME": "UF_CRM_1724412805",
"USER_TYPE_ID": "employee",
"XML_ID": null,
"SORT": "800",
"MULTIPLE": "Y",
"MANDATORY": "Y",
"SHOW_FILTER": "I",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": [],
"EDIT_FORM_LABEL": "Пользовательское поле (Сотрудник)",
"LIST_COLUMN_LABEL": "Пользовательское поле (Сотрудник)",
"LIST_FILTER_LABEL": "Пользовательское поле (Сотрудник)",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null
},
{
"ID": "476",
"ENTITY_ID": "CRM_CONTACT",
"FIELD_NAME": "UF_CRM_1724412914",
"USER_TYPE_ID": "file",
"XML_ID": null,
"SORT": "1200",
"MULTIPLE": "Y",
"MANDATORY": "Y",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"LIST_WIDTH": 0,
"LIST_HEIGHT": 0,
"MAX_SHOW_SIZE": 0,
"MAX_ALLOWED_SIZE": 0,
"EXTENSIONS": [],
"TARGET_BLANK": "Y"
},
"EDIT_FORM_LABEL": "Пользовательское поле (Файл)",
"LIST_COLUMN_LABEL": "Пользовательское поле (Файл)",
"LIST_FILTER_LABEL": "Пользовательское поле (Файл)",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null
}
],
"total": 6,
"time": {
"start": 1724435524.016968,
"finish": 1724435527.855702,
"duration": 3.8387339115142822,
"processing": 0.366832971572876,
"date_start": "2024-08-23T19:52:04+02:00",
"date_finish": "2024-08-23T19:52:07+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, содержит список пользовательских полей. Структура отдельно взятого пользовательского поля идентична |
|
total |
Количество найденных пользовательских полей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Parameter 'filter' must be array."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
Переданный |
|
|
|
Переданный |
|
|
|
У пользователя нет административных прав |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |