метод REST scope: crm

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

Ответ

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 У пользователя нет административных прав

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.