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: crm

Who can execute the method:

  • a user — their own personal settings and shared settings
  • a CRM administrator — personal settings of another user

DEPRECATED

The development of this method has been halted. Please use the REST 3.0 method crm.deal.detailpagelayout.get.

The method crm.deal.details.configuration.get retrieves the personal deal card settings of the specified user or the shared settings 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
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)

Parameter extras Parameter

Required parameters are marked with *

Name
type

Description

dealCategoryId
integer

Identifier of the deal funnel. Can be retrieved using crm.category.list with entityTypeId = 2 or crm.deal.category.list in REST 3.0 — the identifiers are the same

If not specified, the default funnel for deals is used.

Code Examples

How to Use Examples in Documentation

Retrieve the general configuration of the deal card in 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 | number
          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="C",
                extras={"dealCategoryId": 32},
            ).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
type

Description

result
section[]|null

The root element of the response. Contains the configuration of the sections of the deal detail card. It is null if no settings are saved for the selected scope and funnel: for example, the personal card has not been configured or has been reset with crm.deal.details.configuration.reset

time
time

Information about the execution time of the request

Section Object

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. Always section

elements
section_element[]

List of fields displayed in the card with additional settings

Section Element Object

Configuration of an individual field within the section

Name
type

Description

name
string

Field identifier from the method crm.deal.fields, for example, TITLE or UF_CRM_1687529546

optionFlags
integer|string

Whether to always show the field:

  • "1" or 1 — yes
  • "0" or 0 — no

The value is returned in the type in which it was saved. The Bitrix24 interface saves a string. The method crm.deal.details.configuration.set saves a number or a numeric string as passed and does not save a non-numeric value — in that case, the field has no optionFlags in the response

options
object

Additional field options. The composition depends on the field, for example, defaultCountry for CLIENT, isPayButtonVisible and isPaymentDocumentsVisible for OPPORTUNITY_WITH_CURRENCY. Option values are returned as they were saved. The Bitrix24 interface saves them as strings, for example, "true"

Error Handling

HTTP Status: 400

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

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

Empty Value

Access denied.

scope = P and the userId of another user were passed, and the current user is not a CRM administrator

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning