Get the Common Card View ID v 3.0 crm.[type].detailpagelayout.getcommonlayoutid

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

This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The crm.<type>.detailpagelayout.getcommonlayoutid method returns the ID of the common card view of a CRM item in a pipeline. The object type is set by the <type> segment of the method name.

The ID is required for the crm.<type>.detailpagelayout.get, crm.<type>.detailpagelayout.update, and crm.<type>.detailpagelayout.setcurrent methods. It is built from the pipeline: C<categoryId>:common, and common for leads and estimates. The method does not return the view itself.

Method Name for the Object Type

Object type	Method
Deal	`crm.deal.detailpagelayout.getcommonlayoutid`
Lead	`crm.lead.detailpagelayout.getcommonlayoutid`
Contact	`crm.contact.detailpagelayout.getcommonlayoutid`
Company	`crm.company.detailpagelayout.getcommonlayoutid`
Estimate	`crm.quote.detailpagelayout.getcommonlayoutid`
Invoice	`crm.smartinvoice.detailpagelayout.getcommonlayoutid`
CRM document	`crm.smartdocument.detailpagelayout.getcommonlayoutid`
B2E document	`crm.smartb2edocument.detailpagelayout.getcommonlayoutid`
SPA	`crm.smartprocess<entityTypeId>.detailpagelayout.getcommonlayoutid`, for example, `crm.smartprocess1038.detailpagelayout.getcommonlayoutid`

For an SPA, the method name includes the type ID entityTypeId. Type IDs are returned by the crm.type.list method. Card view methods are available for an SPA regardless of the type settings. My company does not have these methods.

The method name is written in lowercase: crm.deal.detailpagelayout.getcommonlayoutid, not crm.deal.detailPageLayout.getCommonLayoutId. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name
type

Description

categoryId*
integer

Pipeline ID. Card views are stored separately for each pipeline.

The value depends on the object type:

lead and estimate — only 0, they have no pipelines
deal, contact, and company — the pipeline ID, 0 is the default pipeline
invoice, documents, and SPA — the pipeline ID. The method replaces 0 with the ID of the default pipeline

Pipeline IDs of deals, contacts, companies, and SPAs are returned by the crm.<type>.category.list method

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.smartprocess1038.detailpagelayout.getcommonlayoutid

The examples retrieve the ID of the common card view of an SPA with the type ID 1038 in the default pipeline. For a different object type, replace the method name according to the table above.

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 '{"categoryId":0}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.detailpagelayout.getcommonlayoutid

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"categoryId":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.detailpagelayout.getcommonlayoutid

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type LayoutIdResult = {
          layoutId: string
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<LayoutIdResult>(
            'crm.smartprocess1038.detailpagelayout.getcommonlayoutid',
            { categoryId: 0 },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Layout ID:', result.layoutId)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getCommonLayoutId() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.detailpagelayout.getcommonlayoutid',
                { categoryId: 0 },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Layout ID:', result.layoutId)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getCommonLayoutId)
        </script>

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.

from b24pysdk import Config
        from b24pysdk.errors import BitrixSDKException
        from b24pysdk.errors.v3 import BitrixAPIError
        
        method = "crm.smartprocess1038.detailpagelayout.getcommonlayoutid"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={"categoryId": 0},
                prefer_version=3,
            )
            result = response["result"]
            print(result["layoutId"])
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.smartprocess1038.detailpagelayout.getcommonlayoutid',
                    ['categoryId' => 0]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

BX24.callMethod(
            'crm.smartprocess1038.detailpagelayout.getcommonlayoutid',
            { categoryId: 0 },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'crm.smartprocess1038.detailpagelayout.getcommonlayoutid',
            ['categoryId' => 0]
        );
        
        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.smartprocess1038.detailpagelayout.getcommonlayoutid", b24.Params{"categoryId": 0}, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.detailpagelayout.getcommonlayoutid: %w", err)
        }
        
        var answer struct {
        	LayoutID string `json:"layoutId"`
        }
        if err := json.Unmarshal(res.Result, &answer); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(answer.LayoutID)

Response Handling

HTTP status: 200

{
            "result": {
                "layoutId": "C69:common"
            },
            "time": {
                "start": 1793706432,
                "finish": 1793706432.249743,
                "duration": 0.24974298477172852,
                "processing": 0,
                "date_start": "2026-11-03T14:47:12+03:00",
                "date_finish": "2026-11-03T14:47:12+03:00",
                "operating_reset_at": 1793707020,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with response data
result.layoutId `string`	Common view ID. If `categoryId` is `0`, for an SPA, an invoice, and documents the ID contains the number of the default pipeline, for example, `C69:common`
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "Required field \"categoryId\" is missing.",
                        "field": "categoryId"
                    }
                ]
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Card view errors are returned with short codes without the BITRIX_REST_V3_ prefix, for example, LAYOUT_NOT_FOUND, and with English text. The HTTP status of these errors varies and is given next to the code. Errors with BITRIX_REST_V3_* codes are returned with the 400 status.

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to Fix
`categoryId`	Required field `categoryId` is missing	Pass `categoryId`. For a lead and an estimate, pass `0`
`categoryId`	This request requires data type `int` in field `categoryId`	Pass `categoryId` as a number, not a string
`categoryId`	Field value must be 0 or greater	Pass `0` or a pipeline ID

Unknown Parameter Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`-`	Unknown field `#FIELD#` found in entity `LayoutDto`	Remove the parameter from the request. The method accepts only `categoryId`

Unsupported Pipeline

Error Code: UNSUPPORTED_CONTEXT, HTTP status: 400

Field	Error description	How to Fix
`-`	This form layout context is not supported	Check `categoryId`: for a lead and an estimate, pass `0`; for other types, pass the ID of an existing pipeline of this object type

Storage Error

Error Code: STORAGE_FAILED, HTTP status: 500

Field	Error description	How to Fix
`-`	Could not complete the operation on the form layout	Retry the request later. If the error persists, contact support

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field	Error description	How to Fix
`-`	Method `#METHOD#` was not found	Check the method name: it is written in lowercase, for example, `crm.deal.detailpagelayout.getcommonlayoutid`. My company does not have card view methods. For an SPA, check `entityTypeId` with the crm.type.list method

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?

Get the Personal Card View ID

Set the Common Card View for All Users

Get the Common Card View ID v 3.0 crm.[type].detailpagelayout.getcommonlayoutid

Method Name for the Object TypeMethod Name for the Object Type

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Unknown Parameter ErrorUnknown Parameter Error

Unsupported PipelineUnsupported Pipeline

Storage ErrorStorage Error

Method Not FoundMethod Not Found

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Name for the Object Type

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Request Validation Errors

Unknown Parameter Error

Unsupported Pipeline

Storage Error

Method Not Found

Statuses and System Error Codes

Continue Learning