Get Parameters of the Deal Card crm.deal.details.configuration.get

Scope: crm

Who 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

Method Development Halted

The method crm.deal.details.configuration.get continues to function, but there is a more relevant alternative: 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 for deal cards may vary across different Sales Funnels. To select a specific funnel, use the extras.dealCategoryId parameter.

Method Parameters

Required parameters are marked with *

Name `type`	Description
scope `string`	The scope of the settings. Possible values: `P` — personal settings `C` — shared settings Default is `P`
userId `user`	User identifier. Required only when requesting personal settings of another user. If not specified, the current user's ID is used.
extras `object`	Additional parameters (detailed description)

Extras Parameter

Required parameters are marked with *

Name
type

Description

dealCategoryId
integer

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.details.configuration.get',
        		{
        			scope: "C",
        			extras: {
        				dealCategoryId: 32,
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('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>';

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 `type`	Description
result `section[]`\|`null`	The root element of the response. Contains the configuration of the sections of the deal detail card. Returns `null` if there is no configuration
time `time`	Information about the execution time of the request

Section Parameter

Describes an individual section with fields within the deal card

Name `type`	Description
name `string`	Unique name of the section used for identification
title `string`	Title of the section
type `string`	Type of the section
elements `section_element[]`	List of fields displayed in the card with additional settings

Section Element Parameter

Configuration of an individual field within the section

Name `type`	Description
name `string`	Field identifier
optionFlags `string`	Values: `"1"` — always show `"0"` — not always show
options `object`	Additional field options

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Access denied."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`400`	Empty Value	Access denied	No rights to retrieve deal card settings

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Set Deal Card Parameters

Get Parameters of the Deal Card crm.deal.details.configuration.get

Method ParametersMethod Parameters

Extras ParameterExtras Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Section ParameterSection Parameter

Section Element ParameterSection Element Parameter

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning