crm.deal.details.configuration.get
Получить параметры карточки сделки
Описание
Метод crm.deal.details.configuration.get получает настройки карточки сделки. Метод читает личные настройки карточки указанного пользователя или общие настройки, заданные для всех пользователей.
Настройки карточки сделок в разных воронках могут отличаться. Для выбора воронки используйте параметр extras.dealCategoryId.
Параметры
scope
string
необязательный
Область применения настроек.
Возможные значения:
- P — личные настройки
- C — общие настройки
По умолчанию — P
userId
user
необязательный
Идентификатор пользователя. Нужен только при запросе личных настроек другого пользователя.
Если не задан, берется текущий
extras
object
необязательный
Дополнительные параметры (подробное описание)
Параметр extras
dealCategoryId
integer
необязательный
Идентификатор воронки сделок. Можно получить с помощью crm.category.list
Если не указан, используется воронка по умолчанию для сделок
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"scope":"C","extras":{"dealCategoryId":32}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.details.configuration.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"scope":"C","extras":{"dealCategoryId":32},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.details.configuration.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 each section returned in result[]
type CrmDealDetailsSection = {
name: string
title: string
type: string
elements: CrmDealDetailsSectionElement[]
}
type CrmDealDetailsSectionElement = {
name: string
optionFlags?: string
options?: Record<string, unknown>
}
try {
const response = await $b24.actions.v2.call.make<CrmDealDetailsSection[] | null>({
method: 'crm.deal.details.configuration.get',
params: {
scope: 'C',
extras: {
dealCategoryId: 32,
},
},
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('Card sections:', result?.length ?? 0, result)
}
} 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 getDealCardConfiguration() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.deal.details.configuration.get',
params: {
scope: 'C',
extras: {
dealCategoryId: 32,
},
},
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('Card sections:', result?.length ?? 0, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDealCardConfiguration)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.deal.details.configuration.get(
scope="P",
user_id=1,
extras={"dealCategoryId": 0},
).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.deal.details.configuration.get',
[
'scope' => 'C',
'extras' => [
'dealCategoryId' => 32,
],
]
);
$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 deal details configuration: ' . $e->getMessage();
}
BX24.callMethod(
'crm.deal.details.configuration.get',
{
scope: "C",
extras: {
dealCategoryId: 32,
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.deal.details.configuration.get',
[
'scope' => 'C',
'extras' => [
'dealCategoryId' => 32,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.deal.details.configuration.get", b24.Params{
"scope": "C",
"extras": b24.Params{
"dealCategoryId": 32,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.deal.details.configuration.get: %w", err)
}
var items []struct {
Name string `json:"name"`
Title string `json:"title"`
Type string `json:"type"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Name, it.Title)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"name": "main",
"title": "О сделке",
"type": "section",
"elements": [
{
"name": "TITLE"
},
{
"name": "OPPORTUNITY_WITH_CURRENCY"
},
{
"name": "STAGE_ID"
},
{
"name": "CLOSEDATE"
},
{
"name": "CLIENT"
}
]
},
{
"name": "additional",
"title": "Дополнительно",
"type": "section",
"elements": [
{
"name": "TYPE_ID"
},
{
"name": "SOURCE_ID",
"optionFlags": "1"
},
{
"name": "SOURCE_DESCRIPTION"
},
{
"name": "BEGINDATE"
},
{
"name": "OPENED"
},
{
"name": "ASSIGNED_BY_ID"
},
{
"name": "OBSERVER"
},
{
"name": "COMMENTS"
},
{
"name": "UTM"
}
]
},
{
"name": "products",
"title": "Товары",
"type": "section",
"elements": [
{
"name": "PRODUCT_ROW_SUMMARY"
}
]
},
{
"name": "recurring",
"title": "Регулярная сделка",
"type": "section",
"elements": [
{
"name": "RECURRING"
}
]
}
],
"time": {
"start": 1773240673,
"finish": 1773240673.91616,
"duration": 0.9161601066589355,
"processing": 0,
"date_start": "2026-03-11T17:51:13+03:00",
"date_finish": "2026-03-11T17:51:13+03:00",
"operating_reset_at": 1773241273,
"operating": 0
}
}
Возвращаемые данные
result
section[]
Корневой элемент ответа. Содержит конфигурацию разделов детальной карточки сделки. Возвращает null в случае отсутствия конфигурации
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
| Код | Описание | Значение |
|---|---|---|
400 |
Пустое значение | Access denied |

