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

Get a CRM setting

GET /v1/crm-settings/:id

Read one CRM setting by the string identifier returned by the settings list.

Parameters

Parameter Type Required Description
Parameterid (path) Typestring Requiredyes DescriptionIdentifier from the settings list.

Examples

curl — personal key

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/crm-settings/crm.layout.file_previewer.enabled" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/crm-settings/crm.layout.file_previewer.enabled" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/crm-settings/crm.layout.file_previewer.enabled', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()

JavaScript — OAuth application

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/crm-settings/crm.layout.file_previewer.enabled', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()

Response fields

Field Description
Fielddata.id DescriptionIdentifier.
Fielddata.value DescriptionJSON value with its original type.
Fielddata.meta.title DescriptionSetting title.
Fielddata.meta.description DescriptionSetting description.
Fielddata.meta.schema DescriptionAccepted value schema, validated by Bitrix24.

Response example

Response structure with neutral sample data.

JSON 
{
  "success": true,
  "data": {
    "id": "crm.layout.file_previewer.enabled",
    "value": true,
    "meta": {
      "title": "File preview",
      "description": "Preview files",
      "schema": {
        "type": "boolean"
      }
    }
  }
}

Error response example

400 — unknown query parameter:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown query parameter"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionInvalid type or identifier.
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionUnknown query parameter.
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no Bitrix24 credentials.
HTTP403 CodeSCOPE_DENIED DescriptionThe crm scope is required.
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe record is absent or inaccessible.
HTTP422 CodeMETHOD_NOT_YET_AVAILABLE DescriptionThe method is absent on the account. error.release names the required release.
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable or returned an invalid response shape.

Other Bitrix24 refusals retain their original code and message. Common API errors.

Known behavior

An object in value replaces the complete setting value. A successful write is not rolled back if its readback fails. Never blindly retry an ambiguous write failure: read the setting first.

See also