Get Parameters For crm.company.details.configuration.get

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:

any user can retrieve their own and shared settings,

a user with the "Allow to modify settings" access permission in CRM can retrieve others' settings.

DEPRECATED

The development of this method has been halted. Please use crm.item.details.configuration.get.

The method crm.company.details.configuration.get retrieves the settings for company cards: it reads the personal settings of the specified user or the shared settings defined for all users.

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, which can be obtained using the user.get method.

Required only for administrators when requesting others' personal settings. If not specified, the settings of the current user will be returned.

Code Examples

How to Use Examples in Documentation

Retrieve personal card configuration

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"P","userId":6}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.details.configuration.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"P","userId":6,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.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[] (result is null when no configuration exists)
        type CrmCompanyDetailsSection = {
          name: string
          title: string
          type: string
          elements: CrmCompanyDetailsSectionElement[]
        }
        
        type CrmCompanyDetailsSectionElement = {
          name: string
          optionFlags?: string
          options?: {
            defaultCountry?: string
            defaultAddressType?: number
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<CrmCompanyDetailsSection[] | null>({
            method: 'crm.company.details.configuration.get',
            params: {
              scope: 'P',
              userId: 6,
            },
            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 getCompanyDetailsConfiguration() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.company.details.configuration.get',
                params: {
                  scope: 'P',
                  userId: 6,
                },
                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', getCompanyDetailsConfiguration)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.details.configuration.get',
                    [
                        'scope' => 'P',
                        'userId' => 6
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.company.details.configuration.get',
            {
                scope: "P",
                userId: 6,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.details.configuration.get',
            [
                'scope' => 'P',
                'userId' => 6
            ]
        );
        
        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.company.details.configuration.get", b24.Params{
        	"scope":  "P",
        	"userId": 6,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.company.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)
        }

Retrieve shared card configuration

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"C"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.details.configuration.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"scope":"C","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.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[] (result is null when no configuration exists)
        type CrmCompanyDetailsSection = {
          name: string
          title: string
          type: string
          elements: CrmCompanyDetailsSectionElement[]
        }
        
        type CrmCompanyDetailsSectionElement = {
          name: string
          optionFlags?: string
          options?: {
            defaultCountry?: string
            defaultAddressType?: number
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<CrmCompanyDetailsSection[] | null>({
            method: 'crm.company.details.configuration.get',
            params: {
              scope: 'C',
            },
            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 getCompanyDetailsConfiguration() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.company.details.configuration.get',
                params: {
                  scope: 'C',
                },
                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', getCompanyDetailsConfiguration)
        </script>


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.company.details.configuration.get(
                scope="C",
            ).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.company.details.configuration.get',
                    [
                        'scope' => 'C'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching company details configuration: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.company.details.configuration.get',
            {
                scope: "C",
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.details.configuration.get',
            [
                'scope' => 'C'
            ]
        );
        
        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.company.details.configuration.get", b24.Params{
        	"scope": "C",
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.company.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 Us",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TITLE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "COMPANY_TYPE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "INDUSTRY",
                            "optionFlags": "0"
                        },
                        {
                            "name": "REVENUE_WITH_CURRENCY",
                            "optionFlags": "0"
                        },
                        {
                            "name": "EMAIL",
                            "optionFlags": "0"
                        },
                        {
                            "name": "CONTACT",
                            "optionFlags": "0",
                            "options": {
                                "defaultCountry": "RU"
                            }
                        },
                        {
                            "name": "UF_CRM_1687188367",
                            "optionFlags": "1"
                        },
                        {
                            "name": "UF_CRM_1706178583916",
                            "optionFlags": "1"
                        },
                        {
                            "name": "COMMENTS",
                            "optionFlags": "1"
                        },
                        {
                            "name": "REQUISITES",
                            "optionFlags": "1"
                        },
                        {
                            "name": "PARENT_ID_164",
                            "optionFlags": "0"
                        },
                        {
                            "name": "LOGO",
                            "optionFlags": "1"
                        },
                        {
                            "name": "PHONE",
                            "optionFlags": "1",
                            "options": {
                                "defaultCountry": "RU"
                            }
                        },
                        {
                            "name": "ADDRESS",
                            "optionFlags": "1"
                        }
                    ]
                },
                {
                    "name": "additional",
                    "title": "Additional Information",
                    "type": "section",
                    "elements": [
                        {
                            "name": "EMPLOYEES",
                            "optionFlags": "0"
                        },
                        {
                            "name": "ASSIGNED_BY_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "UTM",
                            "optionFlags": "0"
                        },
                        {
                            "name": "TRACKING_SOURCE_ID",
                            "optionFlags": "0"
                        }
                    ]
                },
                {
                    "name": "user_pl047oti",
                    "title": "New Section",
                    "type": "section",
                    "elements": [
                        {
                            "name": "UF_CRM_1689255858",
                            "optionFlags": "1"
                        }
                    ]
                }
            ],
            "time": {
                "start": 1769418250,
                "finish": 1769418250.874948,
                "duration": 0.8749480247497559,
                "processing": 0,
                "date_start": "2026-01-26T12:04:10+03:00",
                "date_finish": "2026-01-26T12:04:10+03:00",
                "operating_reset_at": 1769418850,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
section[]

The root element of the response.

Contains the configuration of the sections of the company 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 card with additional settings

Section_Element

Configuration of a specific field within the section

Name `type`	Description
name `string`	Field identifier
optionFlags `boolean`	Whether to always show the field. Possible values: `"1"` — yes `"0"` — no
options `object`	Additional options for the field. The structure is described below

section_element.options

Name
type

Fields where the option is available

Description

defaultAddressType
integer

ADDRESS

Identifier of the default address type. To find out possible address types, use crm.enum.addresstype

defaultCountry
string

PHONE
CLIENT
COMPANY
CONTACT
MYCOMPANY_ID

Country code for the default phone number format — a string of two Latin letters.

For example "RU"

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

Code	Description	Value
Empty value	`Access denied`	The user does not have the "Allow to modify settings" permission to retrieve others' 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 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	The REST API is available only on commercial plans. 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

Was the article helpful?

Overview of Methods

Reset Card Parameters

Get Parameters For crm.company.details.configuration.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

SectionSection

Section_ElementSection_Element

section_element.optionssection_element.options

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Section

Section_Element

section_element.options

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning