For AI agents: markdown of this page — /docs-content-en/entities/crm-card-layouts/get.md documentation index — /llms.txt

Get a CRM card layout

GET /v1/crm/card-layouts/:entityType/:layoutId

Read a named or system CRM card layout by its string identifier.

These methods are rolling out — introduced in crm 26.1700.0. Cloud availability also depends on Bitrix24 enabling this capability. Until it is enabled for your Bitrix24 account, the API returns 422 METHOD_NOT_YET_AVAILABLE with error.release.

Requires crm scope. READONLY keys may read.

Parameters

Parameter Type Required Default Description
ParameterentityType (path) Typestring Requiredyes Default— DescriptionType from the section index.
ParameterlayoutId (path) Typestring Requiredyes Default— DescriptionID from the layout list, common or personal layout.
ParametercategoryId (query) Typeinteger Requiredyes Default— DescriptionCategory from GET /v1/categories, 0 is accepted.
ParameteruserId (query) Typeinteger Requiredno Default— DescriptionEmployee from the user list. Omit to use the calling employee.

Examples

curl — personal key

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/crm/card-layouts/deal/11?categoryId=0" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/crm/card-layouts/deal/11?categoryId=0" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/crm/card-layouts/deal/11?categoryId=0', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_API_KEY"},
});
console.log(await res.json());

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/crm/card-layouts/deal/11?categoryId=0', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
});
console.log(await res.json());

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue
Fielddata Typeobject DescriptionLayout.
Fielddata.id Typestring DescriptionString layout ID.
Fielddata.name Typestring/null DescriptionName, may be null for a system layout.
Fielddata.configuration Typeobject[] DescriptionSections {name,title,elements} with elements {name,optionFlags?,options?}.
Fielddata.audience Typeobject[]/null DescriptionAudience {type,id}, may be null for a system layout.

Response example

JSON 
{
  "success": true,
  "data": {
    "id": "11",
    "name": "VIBE-PROBE",
    "configuration": [
      {
        "name": "main",
        "title": "VIBE-PROBE",
        "elements": [
          {
            "name": "TITLE"
          }
        ]
      }
    ],
    "audience": [
      {
        "type": "user",
        "id": 1
      }
    ]
  }
}

Error response example

400 — category omitted:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "categoryId is required"
  }
}

Errors

HTTP Code Description
HTTP400 CodeMISSING_REQUIRED_FIELDS DescriptionCategory or required body fields missing.
HTTP400 CodeINVALID_PARAMS DescriptionUnsupported entity selector or malformed parameters.
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionUnknown query parameter.
HTTP401 CodeMISSING_API_KEY DescriptionAPI key missing.
HTTP401 CodeTOKEN_MISSING DescriptionBitrix24 credentials missing.
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks crm scope.
HTTP404 CodeENTITY_NOT_FOUND DescriptionBitrix24 reported a missing layout.
HTTP422 CodeMETHOD_NOT_YET_AVAILABLE DescriptionCapability disabled or method unavailable. error.release names the release.
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 refusal. Original code in error.b24Code, text in error.message.
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionNo valid response from Bitrix24.

Common errors: Errors.

See also