Get Parameters of CRM Item Detail Configuration

Scope: crm

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

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

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

The method returns the settings of the detail form for a specific CRM entity. 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 entity 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 user-defined 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. Allowed 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

extras

The extras parameter depends on the CRM entity.

CRM Entity	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 will be used
Deal	`dealCategoryId`	Identifier of the deal funnel. Can be obtained using `crm.category.list`. If not specified, the default funnel identifier for deals will be used
Lead	`leadCustomerType`	Type of leads. Possible values: `1` — simple leads `2` — repeat leads

Code Examples

How to Use Examples in Documentation

Get the shared configuration of item details for deals in the funnel with id = 9, for the user with id = 1

cURL (Webhook)

cURL (OAuth)

PHP

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

    BX24.callMethod(
                'crm.item.details.configuration.get',
                {
                    entityTypeId: 2,
                    userId: 1,
                    scope: "C",
                    extras: {
                        dealCategoryId: 9,
                    },
                },
                (result) => {
                    if (result.error())
                    {
                        console.error(result.error());
        
                        return;
                    }
        
                    console.info(result.data());
                },
            );

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>';

Get the personal configuration of item details for the SPA with entityTypeId = 1032 in the funnel with id = 5

cURL (Webhook)

cURL (OAuth)

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

    BX24.callMethod(
                'crm.item.details.configuration.get',
                {
                    entityTypeId: 1032,
                    extras: {
                        categoryId: 5,
                    },
                },
                (result) => {
                    if (result.error())
                    {
                        console.error(result.error());
        
                        return;
                    }
        
                    console.info(result.data());
                },
            );

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": "US"
                            }
                        },
                        {
                            "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 execution time of the request

section

Describes an individual section with fields within the item detail form

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 detail form with additional settings

section_element

Configuration of an individual field within a section

Name `type`	Description
name `string`	Identifier of the field
optionFlags `string`	Values: `"1"` — always show `"0"` — not always show
options `object`	Additional options for the field

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` is not provided
Empty value	The entity type '`entityTypeName`' is not supported in the 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 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 CRM Entity Detail Form Parameters

Get Parameters of CRM Item Detail Configuration

Method ParametersMethod Parameters

extrasextras

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