Получить описание поля v 3.0 crm.<тип>.field.get

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

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

Scope: crm

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

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

Метод crm.<тип>.field.get возвращает описание одного поля типа объекта CRM по имени. Тип объекта задает сегмент <тип> в имени метода.

Имя метода для типа объекта

Тип объекта	Метод	Поля
Сделка	`crm.deal.field.get`	Поля сделки
Лид	`crm.lead.field.get`	Поля лида
Контакт	`crm.contact.field.get`	Поля контакта
Компания	`crm.company.field.get`	Поля компании
Предложение	`crm.quote.field.get`	Поля предложения
Счет	`crm.smartinvoice.field.get`	Поля счета
Моя компания	`crm.mycompany.field.get`	Поля моей компании
Смарт-процесс	`crm.smartprocess<entityTypeId>.field.get`, например `crm.smartprocess1038.field.get`	Поля смарт-процесса

Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов смарт-процессов возвращает метод crm.type.list в поле entityTypeId. Методы описания полей есть у смарт-процесса при любых настройках типа.

Имя метода пишется в нижнем регистре: crm.smartinvoice.field.get, а не crm.smartInvoice.field.get. На имя в другом регистре метод отвечает ошибкой «Метод не найден».

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

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

Название
тип

Описание

name*
string

Имя поля в camelCase, например stageId, или имя пользовательского поля, например UF_CRM_CONTRACT_NUMBER. Стандартные поля в верхнем регистре, например TITLE, метод не найдет. Список имен возвращает метод crm.<тип>.field.list

select
array

Список полей описания, которые нужно вернуть, например ["name", "type", "editable"]. Поля описания.

По умолчанию метод возвращает все поля описания

Примеры кода

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

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

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

Примеры получают описание поля стадии у смарт-процесса с идентификатором типа 1038. Для другого типа объекта замените имя метода по таблице выше.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"stageId"}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"stageId","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.get

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type FieldGetResult = {
  item: {
    name: string
    type: string
    title: string
    multiple: boolean
    editable: boolean
  }
}

try {
  const response = await $b24.getHttpClient(ApiVersion.v3).call<FieldGetResult>(
    'crm.smartprocess1038.field.get',
    {
      name: 'stageId',
    },
    Text.getUuidRfc4122()
  )

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.item.name, result.item.type, result.item.editable)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getField() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
        'crm.smartprocess1038.field.get',
        {
          name: 'stageId',
        },
        B24Js.Text.getUuidRfc4122()
      )

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.item.name, result.item.type, result.item.editable)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.

from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError

method = "crm.smartprocess1038.field.get"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "name": "stageId",
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result["item"])
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        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.smartprocess1038.field.get',
            [
                'name' => 'stageId',
            ]
        );

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

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

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

BX24.callMethod(
    'crm.smartprocess1038.field.get',
    {
        name: 'stageId',
    },
    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.smartprocess1038.field.get',
    [
        'name' => 'stageId',
    ]
);

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

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

var out struct {
	Item struct {
		Name     string `json:"name"`
		Type     string `json:"type"`
		Editable bool   `json:"editable"`
	} `json:"item"`
}
if err := json.Unmarshal(res.Result, &out); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(out.Item.Name, out.Item.Type, out.Item.Editable)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "name": "stageId",
            "type": "string",
            "elementType": null,
            "multiple": false,
            "title": "Стадия",
            "description": null,
            "validationRules": [],
            "requiredGroups": null,
            "filterable": true,
            "sortable": true,
            "editable": true
        }
    },
    "time": {
        "start": 1793715000,
        "finish": 1793715000.500155,
        "duration": 0.500154972076416,
        "processing": 0,
        "date_start": "2026-11-03T17:10:00+03:00",
        "date_finish": "2026-11-03T17:10:00+03:00",
        "operating_reset_at": 1793715600,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект с данными ответа
result.item `object`	Описание поля. Поля описания
time `time`	Информация о времени выполнения запроса

Поля описания

Название `тип`	Описание
name `string`	Имя поля: у стандартного — в camelCase, например `title`, у пользовательского — вида `UF_CRM_…`
type `string`	Тип данных, например `string`, `int`, `date-time`, `object`
elementType `string`	Тип элемента для составных полей, например `object` у связанного объекта. У простых полей — `null`
multiple `boolean`	Множественное ли поле
title `string`	Название поля на языке Битрикс24
description `string`	Описание поля. Если описания нет — `null`
validationRules `array`	Правила проверки значения, например `{"name": "Length", "parameters": {"max": 255}}` — длина не больше 255 символов
requiredGroups `array`	Методы, в которых поле обязательно на уровне метода, например `["add"]`. Если таких методов нет — `null`. Обязательность из настроек crm.<тип>.field.required.* сюда не попадает. Правило контакта «`name` или `lastName`» тоже не видно: оно приходит только ошибкой crm.<тип>.add
filterable `boolean`	Можно ли фильтровать по полю в методе crm.<тип>.list
sortable `boolean`	Можно ли сортировать по полю в методе crm.<тип>.list
editable `boolean`	Можно ли передавать поле в методах crm.<тип>.add и crm.<тип>.update

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

HTTP-статус: 404

{
    "error": {
        "code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION",
        "message": "Поле `TITLE` не найдено"
    }
}

Название `тип`	Описание
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

Поле	Описание ошибки	Как исправить
`name`	Обязательное поле `name` не указано	Передайте `name`
`name`	В поле `name` требуется тип данных `string` для такого запроса	Передайте имя поля строкой

Поле не найдено

Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION, HTTP-статус 404

Поле	Описание ошибки	Как исправить
`-`	Поле `#NAME#` не найдено	Проверьте имя поля методом crm.<тип>.field.list. Имена стандартных полей пишутся в camelCase: `title`, а не `TITLE`

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Неизвестное поле `#FIELD#` для сущности `CrmFieldMetadataDto`	Проверьте имена в `select` по таблице полей описания

Ошибка формата select

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Не удается распознать выражение select `#VALUE#`	Передайте `select` массивом, например `["name"]`, а не строкой

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP-статус 403

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	Вызовите метод от имени пользователя с правом на чтение элементов этого типа объекта

Метод не найден

Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404

Поле	Описание ошибки	Как исправить
`-`	Метод `#METHOD#` не найден	Проверьте имя метода: оно пишется в нижнем регистре, например `crm.smartinvoice.field.get`. Для смарт-процесса проверьте `entityTypeId` методом crm.type.list

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

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

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

Была ли статья полезна?

Обзор методов

Получить описание полей

Получить описание поля v 3.0 crm.<тип>.field.get

Имя метода для типа объектаИмя метода для типа объекта

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

Примеры кодаПримеры кода

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

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

Поля описанияПоля описания

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

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

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

Поле не найденоПоле не найдено

Ошибка неизвестного поляОшибка неизвестного поля

Ошибка формата selectОшибка формата select

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

Метод не найденМетод не найден

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

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

Была ли статья полезна?

Имя метода для типа объекта

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

Примеры кода

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

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

Поля описания

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

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

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

Поле не найдено

Ошибка неизвестного поля

Ошибка формата select

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

Метод не найден

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

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