crm.contact.userfield.list
Получить список пользовательских полей контактов
Описание
Метод crm.contact.userfield.list возвращает список пользовательских полей контактов по фильтру.
Выводится и информация об этих полях, но без названия, которое присвоил полю пользователь, только внутренний идентификатор. Если нужно пользовательское название поля, воспользуйтесь методом crm.contact.list, который выводит как стандартные поля, так и пользовательские.
Параметры
filter
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
где:
- field_n — название поля, по которому будет отфильтрована выборка пользовательских полей
- value_n — значение фильтра (доступно лишь точное соответствие)
Все условия по отдельным полям соединяются с помощью AND. Смотрите ниже список доступных полей для фильтрации
order
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
где:
- field_n — название поля, по которому будет произведена сортировка выборки элементов
- value_n — значение типа string, равное:
- ASC — сортировка по возрастанию
- DESC — сортировка по убыванию
Список доступных полей для сортировки:
- ID — идентификатор пользовательского поля
- FIELD_NAME — код пользовательского поля
- USER_TYPE_ID — тип пользовательского поля
- XML_ID — внешний код
- SORT — индекс сортировки
По умолчанию:
{
"SORT": "ASC",
"ID": "ASC"
}Доступные для фильтрации поля
ID
integer
необязательный
Идентификатор пользовательского поля
FIELD_NAME
string
необязательный
Код пользовательского поля
USER_TYPE_ID
string
необязательный
Тип пользовательского поля. Возможные значения:
- string — строка
- integer — целое число
- double — число
- boolean — да/нет
- datetime — дата/время
- date — дата
- money — деньги
- url — ссылка
- address — адрес
- enumeration — список
- file — файл
- employee — привязка к сотруднику
- crm_status — привязка к справочнику CRM
- iblock_section — привязка к разделам информационных блоков
- iblock_element — привязка к элементам информационных блоков
- crm — привязка к элементам CRM
- пользовательские типы полей
XML_ID
string
необязательный
Внешний код
SORT
integer
необязательный
Индекс сортировки
MULTIPLE
boolean
необязательный
Является ли пользовательское поле множественным (Y — да / N — нет)
MANDATORY
boolean
необязательный
Является ли пользовательское поле обязательным (Y — да/ N — нет)
SHOW_FILTER
char
необязательный
Показывать ли в фильтре списка. Возможные значения:
- N — не показывать
- I — точное совпадение
- E — маска
- S — подстрока
SHOW_IN_LIST
boolean
необязательный
Показывать ли в списке (Y — да/ N — нет).
Данный параметр ни на что не влияет в рамках crm
EDIT_IN_LIST
boolean
необязательный
Разрешать ли редактирование пользователем (Y — да/ N — нет)
IS_SEARCHABLE
boolean
необязательный
Участвуют ли значения поля в поиске (Y — да/ N — нет)
Данный параметр ни на что не влияет в рамках crm
LANG
string
необязательный
Языковой идентификатор. При фильтрации по данному параметру будет предоставлен набор полей со значениями на переданном языке:
- EDIT_FORM_LABEL — подпись в форме редактирования
- LIST_COLUMN_LABEL — заголовок в списке
- LIST_FILTER_LABEL — подпись фильтра в списке
- ERROR_MESSAGE — сообщение об ошибке
- HELP_MESSAGE — помощь
Примеры запроса
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
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();
}
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.contact.userfield.list", b24.Params{
"filter": b24.Params{
"MULTIPLE": "Y",
"MANDATORY": "Y",
"LANG": "ru",
},
"order": b24.Params{
"USER_TYPE_ID": "ASC",
"SORT": "ASC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.contact.userfield.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
EntityID string `json:"ENTITY_ID"`
FieldName string `json:"FIELD_NAME"`
UserTypeID string `json:"USER_TYPE_ID"`
Sort string `json:"SORT"`
Multiple string `json:"MULTIPLE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.EntityID)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
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
userfield[]
Корневой элемент ответа, содержит список пользовательских полей.
Структура отдельно взятого пользовательского поля идентична userfield за исключением того, что поля: EDIT_FORM_LABEL, LIST_COLUMN_LABEL, LIST_FILTER_LABEL, ERROR_MESSAGE, HELP_MESSAGE отдаются либо в виде string при передаче filter.LANG, либо не отдаются вовсе
total
integer
Количество найденных пользовательских полей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Parameter 'filter' must be array."
}
| Код | Описание | Значение |
|---|---|---|
| — | Parameter 'order' must be array |
Переданный order не является объектом |
| — | Parameter 'filter' must be array |
Переданный filter не является объектом |
| — | Access denied |
У пользователя нет административных прав |

