Get Card Parameters crm.contact.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:

any user can retrieve their own personal settings and the shared settings

a user with the "Allow to change settings" access permission in CRM can retrieve another user's personal settings

DEPRECATED

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

Retrieves the contact card configurations: reads the personal card configurations of the specified user or the shared configurations set 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 — P

userId
user

User identifier. Required only when requesting another user's personal settings.

If not specified, the current user's ID is used

Code Examples

How to Use Examples in Documentation

Retrieve Personal Configuration of the Card

cURL (Webhook)

cURL (OAuth)

BX24.js

PHP

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.contact.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.contact.details.configuration.get

BX24.callMethod(
            'crm.contact.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.contact.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.contact.details.configuration.get", b24.Params{
        	"scope":  "P",
        	"userId": 6,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.contact.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 Configuration of the Card

cURL (Webhook)

cURL (OAuth)

BX24.js

PHP

Python

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.contact.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.contact.details.configuration.get

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

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.details.configuration.get',
            [
                'scope' => 'C'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.contact.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}")

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.contact.details.configuration.get", b24.Params{
        	"scope": "C",
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.contact.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": "Contact information",
                    "type": "section",
                    "elements": [
                        {
                            "name": "LAST_NAME",
                            "optionFlags": "0"
                        },
                        {
                            "name": "PHOTO",
                            "optionFlags": "0"
                        },
                        {
                            "name": "NAME",
                            "optionFlags": "1"
                        },
                        {
                            "name": "SECOND_NAME",
                            "optionFlags": "1"
                        },
                        {
                            "name": "BIRTHDATE",
                            "optionFlags": "1"
                        },
                        {
                            "name": "PHONE",
                            "optionFlags": "1",
                            "options": {
                                "defaultCountry": "AU"
                            }
                        },
                        {
                            "name": "EMAIL",
                            "optionFlags": "1"
                        }
                    ]
                },
                {
                    "name": "additional",
                    "title": "Additional information",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TYPE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "SOURCE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "OPENED",
                            "optionFlags": "0"
                        },
                        {
                            "name": "EXPORT",
                            "optionFlags": "0"
                        },
                        {
                            "name": "ASSIGNED_BY_ID",
                            "optionFlags": "0"
                        }
                    ]
                }
            ],
            "time": {
                "start": 1724677217.639681,
                "finish": 1724677217.986853,
                "duration": 0.3471717834472656,
                "processing": 0.01840806007385254,
                "date_start": "2024-08-26T15:00:17+02:00",
                "date_finish": "2024-08-26T15:00:17+02:00",
                "operating": 0
            }
        }

Returned Values

Name
type

Description

result
section[]

The root element of the response.

Contains the configuration of the sections of the detail form of the entity.

Returns null if there is no configuration

time
time

Information about the request execution time

Section

Describes an individual section containing fields within the item 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 an individual field within a 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

Options

Name `type`	Fields where the option is available	Description
defaultAddressType `integer`	`ADDRESS`	Identifier of the default address type
defaultCountry `string`	`PHONE` `CLIENT` `COMPANY` `CONTACT` `MYCOMPANY_ID`	The country code for the default phone number format is a string of two Latin letters. For example `"RU"`
isPayButtonVisible `boolean`	`OPPORTUNITY_WITH_CURRENCY`	Whether the payment acceptance button is visible. Possible values: `'true'` — visible `'false'` — hidden
isPaymentDocumentsVisible `boolean`	`OPPORTUNITY_WITH_CURRENCY`	Whether the "Payment and Delivery" block is visible. Possible values: `'true'` — visible `'false'` — hidden

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 administrative rights

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

Was the article helpful?

Overview of Methods

Set Individual Card Parameters

Get Card Parameters crm.contact.details.configuration.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned ValuesReturned Values

SectionSection

section_elementsection_element

OptionsOptions

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning