Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-settings/get.md индекс документации — /llms.txt

Получить настройку CRM

GET /v1/crm-settings/:id

Читает одну настройку CRM по строковому идентификатору из списка настроек.

Доступность: в облаке метод доступен. Для коробочной установки требуется обновление CRM crm 26.2000.0. Без него API вернёт 422 METHOD_NOT_YET_AVAILABLE с требуемым выпуском в error.release.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типstring Обяз.да ОписаниеИдентификатор из списка настроек.

Примеры

curl — личный ключ

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

curl — OAuth-приложение

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

JavaScript — личный ключ

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

JavaScript — OAuth-приложение

javascript
const response = await fetch('https://vibecode.bitrix24.tech/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()

Поля ответа

Поле Описание
Полеdata.id ОписаниеИдентификатор.
Полеdata.value ОписаниеЗначение JSON без преобразования типов.
Полеdata.meta.title ОписаниеНазвание настройки.
Полеdata.meta.description ОписаниеОписание настройки.
Полеdata.meta.schema ОписаниеСхема допустимого значения. Проверяется Битрикс24.

Пример ответа

Пример структуры с нейтральными данными.

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

Пример ответа при ошибке

400 — неизвестный параметр:

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

Ошибки

HTTP Код Описание
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный параметр запроса.
HTTP401 КодTOKEN_MISSING ОписаниеНет доступа к Битрикс24 у ключа.
HTTP403 КодSCOPE_DENIED ОписаниеНужен скоуп crm.
HTTP404 КодENTITY_NOT_FOUND ОписаниеЗапись отсутствует или недоступна.
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеНа портале нет метода. Требуемый выпуск указан в error.release.
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеОтвет Битрикс24 недоступен или имеет некорректную структуру.

Другие отказы Битрикс24 сохраняют исходные код и текст. Общие ошибки API.

Известные особенности

Объект в value передаётся целиком, без частичного объединения. Успешное изменение не отменяется, если чтение после записи завершилось ошибкой. Не повторяйте запись вслепую после неоднозначного сбоя: сначала прочитайте настройку.

Смотрите также