Get Parameters of the Deal Card crm.deal.details.configuration.get
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method:
- a user can retrieve their own and shared settings
- personal settings of another user can be accessed if the user has edit rights for that user's personal view
DEPRECATED
The development of this method has been halted. Please use crm.item.details.configuration.get.
The method crm.deal.details.configuration.get retrieves the settings of the deal card. It reads the personal settings of the specified user or the shared settings defined for all users.
Note
The settings of deal cards may vary across different Sales Funnels. To select a funnel, use the extras.dealCategoryId parameter.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
scope |
The scope of the settings. Possible values:
Default is |
|
userId |
User identifier. Required only when requesting personal settings of another user. If not specified, the current user's ID is used. |
|
extras |
Additional parameters (detailed description) |
Parameter extras Parameter
Required parameters are marked with *
|
Name |
Description |
|
dealCategoryId |
Identifier of the deal funnel. Can be obtained using crm.category.list If not specified, the default funnel for deals is used. |
Code Examples
How to Use Examples in Documentation
Example of retrieving the general configuration of the deal card for the funnel with id = 32.
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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {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 and ctx are already created — see the Go SDK section
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("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.Name, it.Title)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"name": "main",
"title": "About the Deal",
"type": "section",
"elements": [
{
"name": "TITLE"
},
{
"name": "OPPORTUNITY_WITH_CURRENCY"
},
{
"name": "STAGE_ID"
},
{
"name": "CLOSEDATE"
},
{
"name": "CLIENT"
}
]
},
{
"name": "additional",
"title": "Additional",
"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": "Products",
"type": "section",
"elements": [
{
"name": "PRODUCT_ROW_SUMMARY"
}
]
},
{
"name": "recurring",
"title": "Recurring Deal",
"type": "section",
"elements": [
{
"name": "RECURRING"
}
]
}
],
"time": {
"start": 1773240673,
"finish": 1773240673.91616,
"duration": 0.9161601066589355,
"processing": 0,
"date_start": "2026-03-11T17:51:13+01:00",
"date_finish": "2026-03-11T17:51:13+01:00",
"operating_reset_at": 1773241273,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response. Contains the configuration of the sections of the deal detail card. Returns |
|
time |
Information about the execution time of the request |
Section Parameter
Describes an individual section with fields within the deal card
|
Name |
Description |
|
name |
Unique name of the section used for identification |
|
title |
Title of the section |
|
type |
Type of the section |
|
elements |
List of fields displayed in the card with additional settings |
Section Element Parameter
Configuration of an individual field within the section
|
Name |
Description |
|
name |
Field identifier |
|
optionFlags |
Values:
|
|
options |
Additional field options |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Access denied."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
Empty Value |
Access denied |
No rights to retrieve deal card settings |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |