Get Parameters of CRM Item Detail Configuration

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute the method: access rights during method execution depend on the provided data:

Any user has the right to retrieve their own and shared settings

A user can access another user's settings only if they are an administrator

The method crm.item.details.configuration.get returns the settings of the detail form for a specific CRM object. It can work with both personal settings of the specified user and shared settings defined for all users.

Note

The settings for repeat lead detail forms may differ from those of simple lead detail forms. The parameter extras.leadCustomerType is used to switch between lead detail form settings.
The settings for the CRM object detail form may vary depending on their Sales Funnel. The parameters used for switching are:
- extras.categoryId — for SPAs
- extras.dealCategoryId — for deals

Method Parameters

Required parameters are marked with *

Name `type`	Description
entityTypeId* `integer`	Identifier of the system or custom type of CRM entities
userId `user`	Identifier of the user whose configuration you want to retrieve. If this parameter is not provided, the `userId` of the user calling this method will be used. Required only when requesting personal settings
scope `string`	Scope of the settings. Acceptable values: `'P'` — personal settings `'C'` — shared settings By default, the value is `'P'`
extras `object`	Additional parameters. Possible values and their structure are described below

Parameter extras

The parameter in extras depends on the CRM object.

CRM Object	Name	Description
SPA	`categoryId`	Identifier of the SPA funnel. Can be obtained using `crm.category.list`. If not specified, the default funnel identifier for this SPA is used
Deal	`dealCategoryId`	Identifier of the deal funnel. Can be obtained using `crm.category.list`. If not specified, the default funnel identifier for deals is used
Lead	`leadCustomerType`	Type of leads. Possible values: `1` — simple leads `2` — repeat leads

Code Examples

How to Use Examples in Documentation

Retrieve the general configuration of item details for deals in the pipeline with id = 9, for the user with id = 1

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

Python

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"userId":1,"scope":"C","extras":{"dealCategoryId":9}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"userId":1,"scope":"C","extras":{"dealCategoryId":9},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.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 the payload returned in result (match the "response handling" section of the page)
        type SectionElement = {
          name: string
          optionFlags: string
          options?: Record<string, string>
        }
        
        type Section = {
          name: string
          title: string
          type: string
          elements: SectionElement[]
        }
        
        try {
          const response = await $b24.actions.v2.call.make<Section[] | null>({
            method: 'crm.item.details.configuration.get',
            params: {
              entityTypeId: 2,
              userId: 1,
              scope: 'C',
              extras: {
                dealCategoryId: 9,
              },
            },
            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('Sections count:', result?.length ?? 0, 'first section:', result?.[0]?.name)
          }
        } 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 getDetailsConfiguration() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.item.details.configuration.get',
                params: {
                  entityTypeId: 2,
                  userId: 1,
                  scope: 'C',
                  extras: {
                    dealCategoryId: 9,
                  },
                },
                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('Sections count:', result?.length ?? 0, 'first section:', result?.[0]?.name)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDetailsConfiguration)
        </script>

require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.details.configuration.get',
            [
                'entityTypeId' => 2,
                'userId' => 1,
                'scope' => "C",
                'extras' => [
                    'dealCategoryId' => 9,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Example

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.item.details.configuration.get(
                entity_type_id=2,
                user_id=1,
                scope="C",
                extras={
                    "dealCategoryId": 9,
                },
            ).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}")

Retrieve the personal configuration of item details for the SPA with entityTypeId = 1032 in the pipeline with id = 5

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":1032,"extras":{"categoryId":5}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":1032,"extras":{"categoryId":5},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.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 the payload returned in result (match the "response handling" section of the page)
        type SectionElement = {
          name: string
          optionFlags: string
          options?: Record<string, string>
        }
        
        type Section = {
          name: string
          title: string
          type: string
          elements: SectionElement[]
        }
        
        try {
          const response = await $b24.actions.v2.call.make<Section[] | null>({
            method: 'crm.item.details.configuration.get',
            params: {
              entityTypeId: 1032,
              extras: {
                categoryId: 5,
              },
            },
            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('Sections count:', result?.length ?? 0, 'first section:', result?.[0]?.name)
          }
        } 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 getDetailsConfiguration() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.item.details.configuration.get',
                params: {
                  entityTypeId: 1032,
                  extras: {
                    categoryId: 5,
                  },
                },
                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('Sections count:', result?.length ?? 0, 'first section:', result?.[0]?.name)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDetailsConfiguration)
        </script>

require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.details.configuration.get',
            [
                'entityTypeId' => 1032,
                'extras' => [
                    'categoryId' => 5,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "name": "main",
                    "title": "About the deal",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TITLE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "STAGE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "OPPORTUNITY_WITH_CURRENCY",
                            "optionFlags": "0"
                        },
                        {
                            "name": "CLOSEDATE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "CLIENT",
                            "optionFlags": "1",
                            "options": {
                                "defaultCountry": "RU"
                            }
                        },
                        {
                            "name": "UF_CRM_1686898039656",
                            "optionFlags": "1"
                        }
                    ]
                },
                {
                    "name": "additional",
                    "title": "Additional",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TYPE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "SOURCE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "SOURCE_DESCRIPTION",
                            "optionFlags": "0"
                        },
                        {
                            "name": "BEGINDATE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "OPENED",
                            "optionFlags": "0"
                        },
                        {
                            "name": "ASSIGNED_BY_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "OBSERVER",
                            "optionFlags": "0"
                        },
                        {
                            "name": "COMMENTS",
                            "optionFlags": "0"
                        },
                        {
                            "name": "UTM",
                            "optionFlags": "0"
                        }
                    ]
                },
                {
                    "name": "products",
                    "title": "Products",
                    "type": "section",
                    "elements": [
                        {
                            "name": "PRODUCT_ROW_SUMMARY",
                            "optionFlags": "0"
                        }
                    ]
                },
                {
                    "name": "recurring",
                    "title": "Recurring deal",
                    "type": "section",
                    "elements": [
                        {
                            "name": "RECURRING",
                            "optionFlags": "0"
                        }
                    ]
                }
            ],
            "time": {
                "start": 1720624891.017344,
                "finish": 1720624891.405621,
                "duration": 0.3882770538330078,
                "processing": 0.02097320556640625,
                "date_start": "2024-07-10T17:21:31+02:00",
                "date_finish": "2024-07-10T17:21:31+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `section[]`\|`null`	Root element of the response. Contains the configuration of the sections of the detail form. Returns `null` if there is no configuration
time `time`	Information about the request execution time

Section

Describes a specific section with fields inside the element 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 entity card with additional settings

Section_Element

Configuration of a specific 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": "Parameter 'entityTypeId' is not defined"
        }

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

Code	Description	Value
Empty value	Parameter 'entityTypeId' is not defined	Required parameter `entityTypeId` not provided
Empty value	The entity type '`entityTypeName`' is not supported in current context.	The method does not support this entity type
Empty value	Access denied.	The user does not have administrative rights

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Was the article helpful?

Overview of Methods

Set CRM Entity Detail Form Parameters

Get Parameters of CRM Item Detail Configuration

Method ParametersMethod Parameters

Parameter extrasParameter extras

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

SectionSection

Section_ElementSection_Element

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning