Получить пользовательское поле контактов по Id crm.contact.userfield.get

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

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

Scope: crm

Кто может выполнять метод: любой пользователь с правом «чтения» контактов

Метод crm.contact.userfield.get возвращает пользовательское поле контактов по идентификатору.

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

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

Название
тип

Описание

id*
integer

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

Идентификатор можно получить с помощью методов crm.contact.userfield.add или crm.contact.userfield.list

Примеры кода

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

Получить пользовательское поле с id = 399

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":399}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.userfield.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":399,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.contact.userfield.get

// 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 the payload returned in result (match the "response handling" section of the page)
type CrmContactUserfield = {
  ID: string
  ENTITY_ID: string
  FIELD_NAME: string
  USER_TYPE_ID: string
  XML_ID: string | null
  SORT: string
  MULTIPLE: string
  MANDATORY: string
}

try {
  const response = await $b24.actions.v2.call.make<CrmContactUserfield>({
    method: 'crm.contact.userfield.get',
    params: {
      id: 399,
    },
    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('Userfield:', result.ID, result.FIELD_NAME)
  }
} 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 getContactUserfield() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.contact.userfield.get',
        params: {
          id: 399,
        },
        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('Userfield:', result.ID, result.FIELD_NAME)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getContactUserfield)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.contact.userfield.get(bitrix_id=399).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(
            'crm.contact.userfield.get',
            [
                'id' => 399,
            ]
        );

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

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        echo 'Data: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting contact user field: ' . $e->getMessage();
}

BX24.callMethod(
    'crm.contact.userfield.get',
    {
        id: 399,
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);

require_once('crest.php');

$result = CRest::call(
    'crm.contact.userfield.get',
    [
        'id' => 399
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.contact.userfield.get", b24.Params{
	"id": 399,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.contact.userfield.get: %w", err)
}

var item 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, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.EntityID)

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

HTTP-статус: 200

{
    "result": {
        "ID": "399",
        "ENTITY_ID": "CRM_CONTACT",
        "FIELD_NAME": "UF_CRM_HELLO_WORLD",
        "USER_TYPE_ID": "string",
        "XML_ID": null,
        "SORT": "1000",
        "MULTIPLE": "Y",
        "MANDATORY": "Y",
        "SHOW_FILTER": "E",
        "SHOW_IN_LIST": "Y",
        "EDIT_IN_LIST": "Y",
        "IS_SEARCHABLE": "Y",
        "SETTINGS": {
            "SIZE": 20,
            "ROWS": 3,
            "REGEXP": "",
            "MIN_LENGTH": 0,
            "MAX_LENGTH": 0,
            "DEFAULT_VALUE": "Привет, мир! Значение по умолчанию"
        },
        "EDIT_FORM_LABEL": {
            "ar": "Поле \u0027Привет, мир!\u0027",
            "br": "Поле \u0027Привет, мир!\u0027",
            "en": "Hello, World! Edit",
            "fr": "Поле \u0027Привет, мир!\u0027",
            "id": "Поле \u0027Привет, мир!\u0027",
            "it": "Поле \u0027Привет, мир!\u0027",
            "ja": "Поле \u0027Привет, мир!\u0027",
            "la": "Поле \u0027Привет, мир!\u0027",
            "ms": "Поле \u0027Привет, мир!\u0027",
            "pl": "Поле \u0027Привет, мир!\u0027",
            "ru": "Привет, мир! Редактировать",
            "sc": "Поле \u0027Привет, мир!\u0027",
            "tc": "Поле \u0027Привет, мир!\u0027",
            "th": "Поле \u0027Привет, мир!\u0027",
            "tr": "Поле \u0027Привет, мир!\u0027",
            "vn": "Поле \u0027Привет, мир!\u0027"
        },
        "LIST_COLUMN_LABEL": {
            "ar": "Поле \u0027Привет, мир!\u0027",
            "br": "Поле \u0027Привет, мир!\u0027",
            "en": "Hello, World! Column",
            "fr": "Поле \u0027Привет, мир!\u0027",
            "id": "Поле \u0027Привет, мир!\u0027",
            "it": "Поле \u0027Привет, мир!\u0027",
            "ja": "Поле \u0027Привет, мир!\u0027",
            "la": "Поле \u0027Привет, мир!\u0027",
            "ms": "Поле \u0027Привет, мир!\u0027",
            "pl": "Поле \u0027Привет, мир!\u0027",
            "ru": "Привет, мир! Колонка",
            "sc": "Поле \u0027Привет, мир!\u0027",
            "tc": "Поле \u0027Привет, мир!\u0027",
            "th": "Поле \u0027Привет, мир!\u0027",
            "tr": "Поле \u0027Привет, мир!\u0027",
            "vn": "Поле \u0027Привет, мир!\u0027"
        },
        "LIST_FILTER_LABEL": {
            "ar": "Привет, мир! Фильтр",
            "br": "Привет, мир! Фильтр",
            "en": "Привет, мир! Фильтр",
            "fr": "Привет, мир! Фильтр",
            "id": "Привет, мир! Фильтр",
            "it": "Привет, мир! Фильтр",
            "ja": "Привет, мир! Фильтр",
            "la": "Привет, мир! Фильтр",
            "ms": "Привет, мир! Фильтр",
            "pl": "Привет, мир! Фильтр",
            "ru": "Привет, мир! Фильтр",
            "sc": "Привет, мир! Фильтр",
            "tc": "Привет, мир! Фильтр",
            "th": "Привет, мир! Фильтр",
            "tr": "Привет, мир! Фильтр",
            "vn": "Привет, мир! Фильтр"
        },
        "ERROR_MESSAGE": {
            "ar": "Поле \u0027Привет, мир!\u0027",
            "br": "Поле \u0027Привет, мир!\u0027",
            "en": "Hello, World! Error",
            "fr": "Поле \u0027Привет, мир!\u0027",
            "id": "Поле \u0027Привет, мир!\u0027",
            "it": "Поле \u0027Привет, мир!\u0027",
            "ja": "Поле \u0027Привет, мир!\u0027",
            "la": "Поле \u0027Привет, мир!\u0027",
            "ms": "Поле \u0027Привет, мир!\u0027",
            "pl": "Поле \u0027Привет, мир!\u0027",
            "ru": "Привет, мир! Ошибка",
            "sc": "Поле \u0027Привет, мир!\u0027",
            "tc": "Поле \u0027Привет, мир!\u0027",
            "th": "Поле \u0027Привет, мир!\u0027",
            "tr": "Поле \u0027Привет, мир!\u0027",
            "vn": "Поле \u0027Привет, мир!\u0027"
        },
        "HELP_MESSAGE": {
            "ar": "Поле \u0027Привет, мир!\u0027",
            "br": "Поле \u0027Привет, мир!\u0027",
            "en": "Hello, World! Help",
            "fr": "Поле \u0027Привет, мир!\u0027",
            "id": "Поле \u0027Привет, мир!\u0027",
            "it": "Поле \u0027Привет, мир!\u0027",
            "ja": "Поле \u0027Привет, мир!\u0027",
            "la": "Поле \u0027Привет, мир!\u0027",
            "ms": "Поле \u0027Привет, мир!\u0027",
            "pl": "Поле \u0027Привет, мир!\u0027",
            "ru": "Привет, мир! Помощь",
            "sc": "Поле \u0027Привет, мир!\u0027",
            "tc": "Поле \u0027Привет, мир!\u0027",
            "th": "Поле \u0027Привет, мир!\u0027",
            "tr": "Поле \u0027Привет, мир!\u0027",
            "vn": "Поле \u0027Привет, мир!\u0027"
        }
    },
    "time": {
        "start": 1724318753.341079,
        "finish": 1724318753.621247,
        "duration": 0.2801680564880371,
        "processing": 0.023567914962768555,
        "date_start": "2024-08-22T11:25:53+02:00",
        "date_finish": "2024-08-22T11:25:53+02:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
userfield

Корневой элемент ответа, содержит информацию о пользовательском поле

time
time

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

userfield

Параметр
тип

Описание

ID
integer

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

ENTITY_ID
string

Строковый идентификатор привязки пользовательского поля к объекту.

В случае методов crm.contact.userfield.* автоматически проставляется значение CRM_CONTACT

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
boolean

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

  • N — не показывать
  • I — точное совпадение
  • E — маска
  • S — подстрока

SHOW_IN_LIST
boolean

Показывать ли пользовательское поле в списке.

Данный параметр ни на что не влияет в рамках crm.

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

  • Y — да
  • N — нет

EDIT_IN_LIST
boolean

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

  • Y — да
  • N — нет

IS_SEARCHABLE
boolean

Участвуют ли значения поля в поиске.

Данный параметр ни на что не влияет в рамках crm.

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

  • Y — да
  • N — нет

SETTINGS
object

Дополнительные параметры поля. Для каждого типа поля (USER_TYPE_ID) существует свой пул доступных настроек, они описаны ниже

LIST
uf_enum_element[]

Список возможных значений для пользовательского поля типа enumeration. Для пользовательских полей другого типа данный параметр не несет смысла

EDIT_FORM_LABEL
lang_map

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

LIST_COLUMN_LABEL
lang_map

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

LIST_FILTER_LABEL
lang_map

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

ERROR_MESSAGE
lang_map

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

HELP_MESSAGE
lang_map

Помощь

USER_TYPE_OWNER
string

CLIENT_ID приложения, который обслуживает данный тип поля.

Отдается в случае, когда тип поля является пользовательским

Параметр settings

Название
тип

Описание

PRECISION
integer

Точность (количество знаков после запятой)

SIZE
integer

Размер поля ввода для отображения

MIN_VALUE
double

Минимальное значение (0 — не проверять)

MAX_VALUE
double

Максимальное значение (0 — не проверять)

DEFAULT_VALUE
double

Значение по умолчанию

Название
тип

Описание

DEFAULT_VALUE
integer

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

  • 0 — нет
  • 1 — да

DISPLAY
string

Внешний вид. Возможные значения:

  • CHECKBOX — флажок
  • RADIO — радиокнопки
  • DROPDOWN — выпадающий список

LABEL
string[]

Подписи для значений, где:

  • элемент массива с индексом 0 — подпись для значения Нет
  • элемент массива с индексом 1 — подпись для значения Да

LABEL_CHECKBOX
string

Подпись флажка

Название
тип

Описание

DEFAULT_VALUE
object

Значение по умолчанию. Объект формата:

{
    TYPE: 'NONE'|'FIXED'|'NONE',
    VALUE: date
}

где:

  • TYPE — тип значения по умолчанию:
    • NONE — отсутствует
    • NOW — текущая дата
    • FIXED — дата из значения VALUE
  • VALUE имеет тип date

Название
тип

Описание

SIZE
integer

Размер поля ввода для отображения

MIN_VALUE
integer

Минимальное значение (0 — не проверять)

MAX_VALUE
integer

Максимальное значение (0 — не проверять)

DEFAULT_VALUE
integer

Значение по умолчанию

Название
тип

Описание

DEFAULT_VALUE
object

Значение по умолчанию. Объект формата:

{
    TYPE: 'NONE'|'FIXED'|'NONE',
    VALUE: datetime
}

где:

  • TYPE — тип значения по умолчанию:
    • NONE — отсутствует
    • NOW — текущая дата со временем
    • FIXED — дата со временем из значения VALUE
  • VALUE имеет тип datetime

USE_SECOND
boolean

Использовать ли секунды. Возможные значения:

  • Y — да
  • N — нет

USE_TIMEZONE
boolean

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

  • Y — да
  • N — нет

Название
тип

Описание

SIZE
integer

Размер поля ввода для отображения

ROWS
integer

Количество строчек поля ввода

REGEXP
string

Регулярное выражение для проверки

MIN_LENGTH
integer

Минимальная длина строки (0 — не проверять)

MAX_LENGTH
integer

Максимальная длина строки (0 — не проверять)

DEFAULT_VALUE
string

Значение по умолчанию

Название
тип

Описание

DISPLAY
string

Внешний вид. Возможные значения:

  • LIST — список
  • CHECKBOX — флажки
  • UI — набираемый список
  • DIALOG — диалог выбора объектов

LIST_HEIGHT
integer

Высота списка

CAPTION_NO_VALUE
string

Подпись при отсутствии значения

SHOW_NO_VALUE
boolean

Показывать ли пустое значение для обязательного поля. Возможные значения:

  • Y — да
  • N — нет

Название
тип

Описание

DISPLAY
string

Внешний вид. Возможные значения:

  • LIST — список
  • CHECKBOX — флажки
  • UI — набираемый список
  • DIALOG — диалог выбора объектов

LIST_HEIGHT
integer

Высота списка

IBLOCK_ID
integer

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

DEFAULT_VALUE
integer

Значение по умолчанию

ACTIVE_FILTER
boolean

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

  • Y — да
  • N — нет

Название
тип

Описание

ENTITY_TYPE
object

Справочник CRM. Структура аналогична возвращаемым элементам метода crm.status.entity.types

Название
тип

Описание

LEAD
boolean

Включена ли привязка к Лидам

CONTACT
boolean

Включена ли привязка к Контактам

COMPANY
boolean

Включена ли привязка к Компаниям

DEAL
boolean

Включена ли привязка к Сделкам

ORDER
boolean

Включена ли привязка к Заказам

QUOTE
boolean

Включена ли привязка к Коммерческим предложениям

SMART_INVOICE
boolean

Включена ли привязка к Новым счетам

DYNAMIC_...
boolean

Включена ли привязка к определенному Смарт-процессу.

Каждое такое поле имеет вид: DYNAMIC_{entityTypeId}, где entityTypeId — идентификатор типа смарт-процесса, к которому включена привязка

Название
тип

Описание

DEFAULT_VALUE
string

Значение по умолчанию.

Значение данного поля имеет формат: {VALUE}|{CURRENCY}, где:

  • VALUE — количество денег по умолчанию
  • CURRENCY — строковый идентификатор валюты

Например: 300|RUB — 300 рублей

Название
тип

Описание

SHOW_MAP
boolean

Показывать карту

Название
тип

Описание

POPUP
boolean

Открывать в новом окне

SIZE
integer

Размер поля ввода для отображения

MIN_LENGTH
integer

Минимальная длина строки (0 — не проверять)

MAX_LENGTH
integer

Максимальная длина строки (0 — не проверять)

DEFAULT_VALUE
string

Значение по умолчанию

ROWS
integer

Количество строчек поля ввода

Название
тип

Описание

SIZE
integer

Размер поля ввода для отображения

LIST_WIDTH
integer

Максимальные ширина для отображения в списке

LIST_HEIGHT
integer

Максимальные высота для отображения в списке

MAX_SHOW_SIZE
integer

Максимально допустимый размер для показа в списке (0 — не ограничивать)

MAX_ALLOWED_SIZE
integer

Максимально допустимый размер файла для загрузки (0 — не проверять)

EXTENSIONS
string[]

Разрешенные расширения

TARGET_BLANK
boolean

Открывать файл в новой вкладке

Тип uf_enum_element

Название
тип

Описание

ID
integer

Идентификатор элемента списка

VALUE
string

Значение элемента списка

SORT
integer

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

DEF
boolean

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

  • Y — да
  • N — нет

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "ID is not defined or invalid."
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

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

Access denied

Возникает в случаях, когда:

  • у пользователя нет административных прав
  • пользователь пытается получить пользовательское поле, не привязанное к контактам

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

ID is not defined or invalid

Переданный id меньше или равен нулю, либо же не передан вовсе

ERROR_NOT_FOUND

The entity with ID 'id' is not found

Пользовательское поле с переданным id не найдено

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

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

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

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

Предыдущая
Изменить существующее пользовательское поле контактов
Следующая
Получить список пользовательских полей контактов