Получить элемент CRM по идентификатору v 3.0 crm.<тип>.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом на чтение элементов этого типа объекта CRM. Для моей компании — администратор CRM
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод crm.<тип>.get возвращает поля элемента CRM по идентификатору. Тип объекта задает сегмент <тип> в имени метода, состав полей в ответе — параметр select.
Имя метода для типа объекта
|
Тип объекта |
Метод |
Поля |
|
Сделка |
|
|
|
Лид |
|
|
|
Контакт |
|
|
|
Компания |
|
|
|
Предложение |
|
|
|
Счет |
|
|
|
Моя компания |
|
|
|
Смарт-процесс |
|
Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов смарт-процессов возвращает метод crm.type.list в поле entityTypeId.
Имя метода пишется в нижнем регистре: crm.smartinvoice.get, а не crm.smartInvoice.get. На имя в другом регистре метод отвечает ошибкой «Метод не найден».
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор элемента. Идентификатор возвращает метод crm.<тип>.add при создании элемента. Идентификаторы существующих элементов можно получить методом crm.<тип>.list |
|
select |
Список полей, которые нужно вернуть в ответе. Описание параметра Если параметр не передан, ответ содержит только |
Параметр select
Имена полей пишутся в camelCase: title, stageId, assignedById. Состав полей у каждого типа объекта свой, описания полей — на страницах:
- поля сделки
- поля лида
- поля контакта
- поля компании
- поля предложения
- поля счета
- поля моей компании
- поля смарт-процесса
Список полей возвращает метод crm.<тип>.field.list.
Ответ содержит только поля из select. Поле id не добавляется автоматически — передайте его в списке, если оно нужно в ответе. Звездочка * не поддерживается: метод вернет ошибку неизвестного поля.
Связанные объекты запрашиваются по имени поля без суффикса Id: assignedBy, createdBy, stage, category. Есть два способа:
- имя связанного объекта целиком, например
assignedBy, — ответ содержит все поля объекта. Для связанных элементов CRM —contact,companyи других — возвращается толькоid - путь через точку, например
assignedBy.firstNameилиstage.name, — ответ содержит только выбранные поля объекта
Если связь не заполнена, связанный объект возвращается как null, а множественный, например observers, — как пустой массив.
Пользовательские поля передаются по имени, например UF_CRM_1687529546. Их список возвращает метод crm.<тип>.field.custom.list.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.smartprocess1038.get
Примеры получают элемент смарт-процесса с идентификатором типа 1038: название, стадию с ее названием, ответственного с именем и фамилией, сумму и дату создания. Для другого типа объекта замените имя метода по таблице выше.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15,"select":["id","title","stageId","stage.name","assignedById","assignedBy.firstName","assignedBy.lastName","opportunity","currencyId","createdTime"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15,"select":["id","title","stageId","stage.name","assignedById","assignedBy.firstName","assignedBy.lastName","opportunity","currencyId","createdTime"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.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 ItemGetResult = {
item: {
id: number
title: string
stageId: string
assignedById: number
opportunity: number
currencyId: string
createdTime: string
stage: {
name: string
} | null
assignedBy: {
firstName: string
lastName: string
} | null
}
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<ItemGetResult>(
'crm.smartprocess1038.get',
{
id: 15,
select: [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const item = response.getData()!.result.item
console.info(item.title, item.stage?.name, item.assignedBy?.firstName)
}
} 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 getItem() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.smartprocess1038.get',
{
id: 15,
select: [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const item = response.getData().result.item
console.info(item.title, item.stage?.name, item.assignedBy?.firstName)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getItem)
</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.get"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"id": 15,
"select": [
"id",
"title",
"stageId",
"stage.name",
"assignedById",
"assignedBy.firstName",
"assignedBy.lastName",
"opportunity",
"currencyId",
"createdTime",
],
},
prefer_version=3,
)
item = response["result"]["item"]
print(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.get',
[
'id' => 15,
'select' => [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'crm.smartprocess1038.get',
{
id: 15,
select: [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
},
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.get',
[
'id' => 15,
'select' => [
'id',
'title',
'stageId',
'stage.name',
'assignedById',
'assignedBy.firstName',
'assignedBy.lastName',
'opportunity',
'currencyId',
'createdTime',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.get", b24.Params{
"id": 15,
"select": []string{
"id",
"title",
"stageId",
"stage.name",
"assignedById",
"assignedBy.firstName",
"assignedBy.lastName",
"opportunity",
"currencyId",
"createdTime",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.smartprocess1038.get: %w", err)
}
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет item")
}
var item struct {
ID int `json:"id"`
Title string `json:"title"`
StageID string `json:"stageId"`
Opportunity float64 `json:"opportunity"`
CurrencyID string `json:"currencyId"`
Stage struct {
Name string `json:"name"`
} `json:"stage"`
AssignedBy struct {
FirstName string `json:"firstName"`
LastName string `json:"lastName"`
} `json:"assignedBy"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Title, item.Stage.Name, item.AssignedBy.FirstName)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"id": 15,
"title": "Заявка на закупку оборудования",
"stageId": "DT1038_69:PREPARATION",
"assignedById": 1,
"opportunity": 180000,
"currencyId": "RUB",
"createdTime": "2026-11-03T14:39:32+03:00",
"stage": {
"name": "Подготовка"
},
"assignedBy": {
"firstName": "Мария",
"lastName": "Петрова"
}
}
},
"time": {
"start": 1793706172,
"finish": 1793706172.777702,
"duration": 0.7777020931243896,
"processing": 0,
"date_start": "2026-11-03T14:42:52+03:00",
"date_finish": "2026-11-03T14:42:52+03:00",
"operating_reset_at": 1793706720,
"operating": 0
}
}
Без параметра select метод возвращает только идентификатор:
{
"result": {
"item": {
"id": 15
}
},
"time": {
"start": 1793705990,
"finish": 1793705990.170455,
"duration": 0.1704549789428711,
"processing": 0,
"date_start": "2026-11-03T14:39:50+03:00",
"date_finish": "2026-11-03T14:39:50+03:00",
"operating_reset_at": 1793706540,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.item |
Значения полей элемента из |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
"message": "Неизвестное поле `name` для сущности `EmployeeDto`"
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Элемент не найден
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
Проверьте идентификатор элемента. Элемента с таким |
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте |
|
|
Значение поля должно быть не меньше, чем 1 |
Передайте положительный идентификатор |
|
|
В поле |
Передайте |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Проверьте имя поля в |
Ошибка формата select
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение select |
Передайте |
Метод не найден
Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404
|
Поле |
Описание ошибки |
Как исправить |
|
|
Метод |
Проверьте имя метода: оно пишется в нижнем регистре, например |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |