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

Получить запись справочника CRM

GET /v1/crm-dictionaries/:dictionary/:id

Получает запись справочника CRM по её строковому идентификатору: тип связи, поставщика дел или семантику стадии.

Возможность в процессе раскатки. Требуется обновление CRM после 26.2200.0 и включение администратором. Номер выпуска ещё не опубликован. До доступности — 422 METHOD_NOT_YET_AVAILABLE с полем error.release.

Параметры

Параметр Тип Обяз. Описание
Параметрdictionary (path) Типstring Обяз.да ОписаниеСправочник из таблицы ниже
Параметрid (path) Типstring Обяз.да ОписаниеНепустой идентификатор записи из списка этого справочника. Сохраняйте регистр
dictionary Содержание Пример id
dictionaryactivity-providers СодержаниеПоставщики дел Пример idCRM_TODO
dictionaryemail-types СодержаниеТипы электронной почты Пример idWORK
dictionaryphone-types СодержаниеТипы телефонов Пример idWORK
dictionaryim-types СодержаниеТипы мессенджеров Пример idFACEBOOK
dictionaryweb-types СодержаниеТипы сайтов Пример idWORK
dictionarystage-semantics СодержаниеСемантика стадий Пример idF

Параметры строки запроса и тело не принимаются. Чтение разрешено ключам READONLY со скоупом crm.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-dictionaries/activity-providers/CRM_TODO" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-dictionaries/activity-providers/CRM_TODO" \
  -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-dictionaries/activity-providers/CRM_TODO',
  {
    headers: {
      'X-Api-Key': 'YOUR_API_KEY'
    }
  }
)
const { success, data } = await response.json()

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

javascript 
const response = await fetch(
  'https://vibecode.bitrix24.tech/v1/crm-dictionaries/activity-providers/CRM_TODO',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      Authorization: 'Bearer USER_SESSION_TOKEN'
    }
  }
)
const { success, data } = await response.json()

Поля ответа

HTTP 200 OK.

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типobject ОписаниеЗапись выбранного справочника
Полеdata.id Типstring ОписаниеИдентификатор записи из списка справочника

Поставщики дел

Поле Тип Описание
Полеdata.name Типstring ОписаниеНазвание поставщика дел
Полеdata.isAvailable Типboolean ОписаниеДоступен на портале
Полеdata.isActive Типboolean ОписаниеАктивен
Полеdata.types Типarray ОписаниеТипы дел этого поставщика
Полеdata.types[].providerTypeId Типstring ОписаниеИдентификатор типа внутри поставщика
Полеdata.types[].name Типstring ОписаниеНазвание типа дела
Полеdata.types[].directions Типobject ОписаниеНазвания направлений. Ключи incoming, outgoing, undefined со строковыми значениями. Если направлений нет — {}
Полеdata.defaultTypeId Типstring / null ОписаниеИдентификатор типа по умолчанию из data.types[].providerTypeId, если задан
Полеdata.capabilities Типstring[] ОписаниеКоды возможностей поставщика

Типы электронной почты, телефонов, мессенджеров и сайтов

Поле Тип Описание
Полеdata.name Типstring / null ОписаниеНазвание типа
Полеdata.nameShort Типstring / null ОписаниеКраткое название
Полеdata.isDeprecated Типboolean ОписаниеТип устарел

Семантика стадий

Поле Тип Описание
Полеdata.name Типstring ОписаниеНазвание результата стадии

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

Поставщик дел:

JSON 
{
  "success": true,
  "data": {
    "id": "CRM_TODO",
    "name": "Дело",
    "isAvailable": true,
    "isActive": true,
    "types": [
      {
        "providerTypeId": "TODO",
        "name": "Дело",
        "directions": {}
      }
    ],
    "defaultTypeId": "TODO",
    "capabilities": [
      "calendar",
      "completion",
      "ping",
      "badge",
      "timeline"
    ]
  }
}

Тип электронной почты:

JSON 
{
  "success": true,
  "data": {
    "id": "WORK",
    "name": "Рабочий e-mail",
    "nameShort": "Рабочий",
    "isDeprecated": false
  }
}

Семантика стадии:

JSON 
{
  "success": true,
  "data": {
    "id": "F",
    "name": "Провал"
  }
}

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

404 — запись не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `DUMMY_UNKNOWN` не найдена"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректная форма запроса
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеПередан параметр строки запроса
HTTP404 КодENTITY_NOT_FOUND ОписаниеЗапись с указанным идентификатором не найдена
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеВозможность ещё недоступна. Сведения об обновлении — в error.release
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеНекорректный ответ Битрикс24
HTTP401 КодMISSING_API_KEY ОписаниеНе передан X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеНет токенов для обращения к Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеКлючу нужен скоуп crm

Полный список общих ошибок API — Ошибки.

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