Получить поля элемента crm.item.fields

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

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

Scope: crm

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

Метод получает список полей и их конфигурацию для элементов типа entityTypeId.

Важно

У элементов, принадлежащих разным типам объектов CRM, будут разные наборы полей.

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

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

Название
тип

Описание

entityTypeId*
integer

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

Числовые значения для системных типов (Лид — 1, Сделка — 2, Контакт — 3, Компания — 4, Счёт — 31 и др.) приведены в справочнике типов объектов CRM. Идентификатор смарт-процесса можно узнать методом crm.type.list

useOriginalUfNames
boolean

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

  • Y — оригинальные имена пользовательских полей, например UF_CRM_2_1639669411830
  • N — имена пользовательских полей в camelCase, например ufCrm2_1639669411830

По умолчанию — N

Примеры кода

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

Получить список полей у элементов смарт-процесса с entityTypeId = 1268

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":1268,"useOriginalUfNames":"N"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.fields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":1268,"useOriginalUfNames":"N","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.fields
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.item.fields',
        		{
        			entityTypeId: 1268,
        			useOriginalUfNames: 'N',
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.item.fields',
                    [
                        'entityTypeId'      => 1268,
                        'useOriginalUfNames' => 'N',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                return;
            }
        
            echo 'Success: ' . print_r($result->data(), true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching CRM item fields: ' . $e->getMessage();
        }
        
    BX24.callMethod(
                'crm.item.fields',
                {
                    entityTypeId: 1268,
                    useOriginalUfNames: 'N',
                },
                (result) => {
                    if (result.error())
                    {
                        console.error(result.error());
        
                        return;
                    }
        
                    console.info(result.data());
                },
            );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.fields',
            [
                'entityTypeId' => 1268,
                'useOriginalUfNames' => 'N',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "fields": {
                    "id": {
                        "type": "integer",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "ID",
                        "upperName": "ID"
                    },
                    "title": {
                        "type": "string",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Название",
                        "upperName": "TITLE"
                    },
                    "xmlId": {
                        "type": "string",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Внешний код",
                        "upperName": "XML_ID"
                    },
                    "createdTime": {
                        "type": "datetime",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Когда создан",
                        "upperName": "CREATED_TIME"
                    },
                    "updatedTime": {
                        "type": "datetime",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Когда обновлен",
                        "upperName": "UPDATED_TIME"
                    },
                    "createdBy": {
                        "type": "user",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Кем создан",
                        "upperName": "CREATED_BY"
                    },
                    "updatedBy": {
                        "type": "user",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Кем обновлен",
                        "upperName": "UPDATED_BY"
                    },
                    "assignedById": {
                        "type": "user",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Ответственный",
                        "upperName": "ASSIGNED_BY_ID"
                    },
                    "opened": {
                        "type": "boolean",
                        "isRequired": true,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Доступно для всех",
                        "upperName": "OPENED"
                    },
                    "webformId": {
                        "type": "integer",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Создано CRM-формой",
                        "upperName": "WEBFORM_ID"
                    },
                    "begindate": {
                        "type": "date",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Дата начала",
                        "upperName": "BEGINDATE"
                    },
                    "closedate": {
                        "type": "date",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Дата завершения",
                        "upperName": "CLOSEDATE"
                    },
                    "companyId": {
                        "type": "crm_company",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Компания",
                        "settings": {
                            "parentEntityTypeId": 4
                        },
                        "upperName": "COMPANY_ID"
                    },
                    "contactId": {
                        "type": "crm_contact",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "isDeprecated": true,
                        "title": "Контакт",
                        "upperName": "CONTACT_ID"
                    },
                    "contactIds": {
                        "type": "crm_contact",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": true,
                        "isDynamic": false,
                        "title": "CONTACT_IDS",
                        "upperName": "CONTACT_IDS"
                    },
                    "contacts": {
                        "type": "crm_contact",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": true,
                        "isDynamic": false,
                        "title": "CONTACTS",
                        "upperName": "CONTACTS"
                    },
                    "observers": {
                        "type": "user",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": true,
                        "isDynamic": false,
                        "title": "Наблюдатели",
                        "upperName": "OBSERVERS"
                    },
                    "categoryId": {
                        "type": "crm_category",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Воронка",
                        "upperName": "CATEGORY_ID"
                    },
                    "movedTime": {
                        "type": "datetime",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Когда передвинут",
                        "upperName": "MOVED_TIME"
                    },
                    "movedBy": {
                        "type": "user",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Кем передвинут",
                        "upperName": "MOVED_BY"
                    },
                    "stageId": {
                        "type": "crm_status",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "statusType": "DYNAMIC_1268_STAGE_52",
                        "title": "Стадия",
                        "upperName": "STAGE_ID"
                    },
                    "previousStageId": {
                        "type": "crm_status",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "statusType": "DYNAMIC_1268_STAGE_52",
                        "title": "Предыдущая стадия",
                        "upperName": "PREVIOUS_STAGE_ID"
                    },
                    "sourceId": {
                        "type": "crm_status",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "statusType": "SOURCE",
                        "title": "Источник",
                        "upperName": "SOURCE_ID"
                    },
                    "sourceDescription": {
                        "type": "text",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Дополнительно об источнике",
                        "upperName": "SOURCE_DESCRIPTION"
                    },
                    "currencyId": {
                        "type": "crm_currency",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Валюта",
                        "upperName": "CURRENCY_ID"
                    },
                    "isManualOpportunity": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Режим расчета суммы",
                        "upperName": "IS_MANUAL_OPPORTUNITY"
                    },
                    "opportunity": {
                        "type": "double",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Сумма",
                        "upperName": "OPPORTUNITY"
                    },
                    "taxValue": {
                        "type": "double",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Сумма налога",
                        "upperName": "TAX_VALUE"
                    },
                    "mycompanyId": {
                        "type": "crm_company",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Реквизиты вашей компании",
                        "settings": {
                            "isMyCompany": true,
                            "parentEntityTypeId": 4,
                            "isEmbeddedEditorEnabled": true
                        },
                        "upperName": "MYCOMPANY_ID"
                    },
                    "lastActivityBy": {
                        "type": "user",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Кем осуществлена последняя активность в таймлайне",
                        "upperName": "LAST_ACTIVITY_BY"
                    },
                    "lastActivityTime": {
                        "type": "datetime",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Последняя активность",
                        "upperName": "LAST_ACTIVITY_TIME"
                    },
                    "parentId1": {
                        "type": "crm_entity",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Лид",
                        "settings": {
                            "parentEntityTypeId": 1
                        },
                        "upperName": "PARENT_ID_1"
                    },
                    "parentId2": {
                        "type": "crm_entity",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Сделка",
                        "settings": {
                            "parentEntityTypeId": 2
                        },
                        "upperName": "PARENT_ID_2"
                    },
                    "parentId1248": {
                        "type": "crm_entity",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Смарт-процесс #16",
                        "settings": {
                            "parentEntityTypeId": 1248
                        },
                        "upperName": "PARENT_ID_1248"
                    }
                }
            },
            "time": {
                "start": 1721038185.626335,
                "finish": 1721038186.072804,
                "duration": 0.4464690685272217,
                "processing": 0.17344903945922852,
                "date_start": "2024-07-15T12:09:45+02:00",
                "date_finish": "2024-07-15T12:09:46+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа. Содержит единственный ключ fields

fields
object

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

{
            field_1: value_1,
            field_2: value_2,
            ...
            field_n: value_n,
        }

где:

time
time

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

По умолчанию имена пользовательских полей возвращаются в camelCase, например ufCrm2_1639669411830.
При передаче параметра useOriginalUfNames со значением Y пользовательские поля будут возвращаться с оригинальными именами, например UF_CRM_2_1639669411830.

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

HTTP-статус: 400, 403

{
            "error": "NOT_FOUND", 
            "error_description": "Смарт-процесс не найден"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

403

allowed_only_intranet_user

Действие разрешено только интранет-пользователям

Пользователь не является интранет-пользователем

400

NOT_FOUND

Смарт-процесс не найден

Возникает, при передаче невалидного entityTypeId

400

ACCESS_DENIED

У Вас нет прав на просмотр этого элемента

У пользователя нет прав на чтение элементов типа entityTypeId

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

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

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Удалить элемент
Следующая
Поля объектов CRM