Получить поля объектов CRM для CRM-формы crm.form.entityfield.list

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

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

Scope: crm

Кто может выполнять метод: пользователь с правом на просмотр CRM-форм

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.form.entityfield.list возвращает поля объектов CRM, из которых можно собрать CRM-форму.

Через REST нельзя добавить в форму поля с вариантами выбора: список, флажки, переключатели. Метод возвращает такие поля, например с типом list, но crm.form.validate и crm.form.add их не принимают.

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

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

Название
тип

Описание

filter*
array

Фильтр по объектам CRM, поля которых нужно получить. Фильтр обязателен и содержит ровно одно условие по полю entityName:

  • ["entityName", "=", "LEAD"] — поля одного объекта
  • ["entityName", "in", ["CONTACT", "DEAL"]] — поля нескольких объектов, не больше 10 значений

Коды объектов возвращает метод crm.form.configuration.get в поле entitySchemes[].entityNames, например LEAD, CONTACT, COMPANY, DEAL, QUOTE, DYNAMIC_174. Регистр кода не учитывается.

Другие поля, операторы кроме = и in, логика or и отрицание в фильтре не поддерживаются. Если передать пустой список в in, метод вернет пустой массив items

Сортировка, постраничная навигация и select не поддерживаются: метод возвращает все поля выбранных объектов.

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.form.entityfield.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["entityName","in",["CONTACT","DEAL"]]]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.entityfield.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["entityName","in",["CONTACT","DEAL"]]],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.form.entityfield.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 the payload returned in result (match the "response handling" section of the page)
type FormEntityFieldListResult = {
  items: Array<{
    name: string
    label: string
    type: string
    required: boolean
    multiple: boolean
    entityName: string
    entityLabel: string
    items: Array<{ id: string, label: string }>
  }>
}

try {
  const response = await $b24.actions.v3.call.make<FormEntityFieldListResult>({
    method: 'crm.form.entityfield.list',
    params: {
      filter: [
        ['entityName', 'in', ['CONTACT', 'DEAL']],
      ],
    },
    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(result.items.map(field => `${field.name}: ${field.label}`))
  }
} 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 getFormEntityFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'crm.form.entityfield.list',
        params: {
          filter: [
            ['entityName', 'in', ['CONTACT', 'DEAL']],
          ],
        },
        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(result.items)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getFormEntityFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.form.entityfield.list(
        filter=[
            ["entityName", "in", ["CONTACT", "DEAL"]],
        ],
    ).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}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.form.entityfield.list',
            [
                'filter' => [
                    ['entityName', 'in', ['CONTACT', 'DEAL']],
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);

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

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'crm.form.entityfield.list',
    {
        filter: [
            ['entityName', 'in', ['CONTACT', 'DEAL']],
        ],
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'crm.form.entityfield.list',
    [
        'filter' => [
            ['entityName', 'in', ['CONTACT', 'DEAL']],
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.form.entityfield.list", b24.Params{
	"filter": []any{
		[]any{"entityName", "in", []string{"CONTACT", "DEAL"}},
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.form.entityfield.list: %w", err)
}

// Метод заворачивает список в объект с ключом "items".
raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
	return fmt.Errorf("в ответе нет ключа items")
}

var items []struct {
	Name       string `json:"name"`
	Label      string `json:"label"`
	Type       string `json:"type"`
	Required   bool   `json:"required"`
	EntityName string `json:"entityName"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, field := range items {
	fmt.Println(field.EntityName, field.Name, field.Type)
}

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

HTTP-статус: 200

Пример сокращен: в списке оставлено три поля из 98.

{
    "result": {
        "items": [
            {
                "name": "CONTACT_HONORIFIC",
                "label": "Обращение",
                "type": "list",
                "required": false,
                "multiple": false,
                "entityName": "CONTACT",
                "entityLabel": "Контакт",
                "items": [
                    {
                        "id": "HNR_RU_1",
                        "label": "г-н"
                    },
                    {
                        "id": "HNR_RU_2",
                        "label": "г-жа"
                    }
                ]
            },
            {
                "name": "CONTACT_NAME",
                "label": "Имя",
                "type": "string",
                "required": true,
                "multiple": false,
                "entityName": "CONTACT",
                "entityLabel": "Контакт",
                "items": []
            },
            {
                "name": "CONTACT_PHONE",
                "label": "Телефон",
                "type": "typed_string",
                "required": false,
                "multiple": true,
                "entityName": "CONTACT",
                "entityLabel": "Контакт",
                "items": []
            }
        ]
    },
    "time": {
        "start": 1792594067,
        "finish": 1792594068.0578,
        "duration": 1.057800054550171,
        "processing": 1,
        "date_start": "2026-10-21T17:47:47+03:00",
        "date_finish": "2026-10-21T17:47:48+03:00",
        "operating_reset_at": 1792594620,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

items
object[]

Массив полей объектов CRM (подробное описание)

time
time

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

Элемент items

Название
тип

Описание

name
string

Код поля, например CONTACT_NAME. Передается в fields[].name при создании или изменении формы

label
string

Название поля

type
string

Тип поля, например string, typed_string, list, date, file, address. Поля с типами list и checkbox в форму через REST добавить нельзя

required
boolean

Признак обязательного поля в CRM

multiple
boolean

Признак множественного поля

entityName
string

Код объекта CRM, которому принадлежит поле

entityLabel
string

Название объекта CRM

items
object[]

Варианты значений поля-списка: элементы с полями id — значение, которое сохраняется в CRM, и label — название варианта. Для остальных полей массив пустой

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_CRM_V2_INFRASTRUCTURE_REST_EXCEPTION_FORM_UNKNOWNFORMENTITYEXCEPTION",
        "message": "Неизвестные типы элементов CRM: FOO"
    }
}

Название
тип

Описание

error.code
string

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

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

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

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

filter

Значение поля не может быть пустым

Передайте фильтр с условием по entityName

name

В DTO EntityFieldDto в поле name требуется наличие атрибута Filterable для такого запроса

Фильтруйте только по entityName

Ошибки фильтра

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Поле

Описание ошибки

Как исправить

filter

Не удается распознать выражение фильтра #FILTER#

Передайте одно условие по entityName с оператором = или in. В in укажите не больше 10 значений, не используйте логику or и отрицание

Неизвестный объект CRM

Код ошибки: BITRIX_CRM_V2_INFRASTRUCTURE_REST_EXCEPTION_FORM_UNKNOWNFORMENTITYEXCEPTION

Поле

Описание ошибки

Как исправить

filter

Неизвестные типы элементов CRM: #ENTITY_NAMES#

Укажите коды объектов из entitySchemes[].entityNames метода crm.form.configuration.get

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Выдайте пользователю право на просмотр CRM-форм

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

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

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

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