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

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

GET /v1/crm-dictionaries/:dictionary

Возвращает страницу значений выбранного справочника CRM для настройки дел, контактных данных и стадий.

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

Параметры

Параметр Тип Обяз. По умолч. Описание
Параметрdictionary (path) Типstring Обяз.да По умолч.— Описаниеactivity-providers, email-types, phone-types, im-types, web-types, stage-semantics
Параметрlimit (query) Типinteger Обяз.нет По умолч.50 ОписаниеРазмер страницы от 1 до 1000
Параметрoffset (query) Типinteger Обяз.нет По умолч.0 ОписаниеКоличество пропускаемых записей, неотрицательное целое

Для следующей страницы увеличьте offset на limit. Ответ содержит одну страницу без общего количества записей.

Примеры

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/crm-dictionaries/email-types?limit=2" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/crm-dictionaries/email-types?limit=2" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-dictionaries/email-types?limit=2', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const result = await res.json()
console.log(result)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-dictionaries/email-types?limit=2', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const result = await res.json()
console.log(result)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue
Полеdata Типarray ОписаниеЗначения справочника
Полеdata[].id Типstring ОписаниеID для чтения значения
Полеdata[].name Типstring | null ОписаниеНазвание. null допустим для типов контактных данных
Полеdata[].nameShort Типstring | null ОписаниеКраткое название, только типы контактных данных
Полеdata[].isDeprecated Типboolean ОписаниеУстарел ли тип контактных данных
Полеdata[].isAvailable Типboolean ОписаниеДоступен ли поставщик дел, только activity-providers
Полеdata[].isActive Типboolean ОписаниеАктивен ли поставщик дел
Полеdata[].types Типarray ОписаниеТипы дел поставщика
Полеdata[].types[].providerTypeId Типstring ОписаниеID типа дела из этого массива
Полеdata[].types[].name Типstring ОписаниеНазвание типа дела
Полеdata[].types[].directions Типobject ОписаниеНаправления типа дела
Полеdata[].defaultTypeId Типstring | null ОписаниеТип дела по умолчанию, из types[].providerTypeId
Полеdata[].capabilities Типstring[] ОписаниеВозможности поставщика дел
Полеmeta.limit Типinteger ОписаниеЗапрошенный размер страницы
Полеmeta.offset Типinteger ОписаниеЗапрошенный отступ

Поля types, defaultTypeId, capabilities, isAvailable, isActive относятся только к activity-providers. Для stage-semantics элемент содержит id и name.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": "WORK",
      "name": "Рабочий e-mail",
      "nameShort": "Рабочий",
      "isDeprecated": false
    },
    {
      "id": "HOME",
      "name": "Частный e-mail",
      "nameShort": "Частный",
      "isDeprecated": false
    }
  ],
  "meta": {
    "limit": 2,
    "offset": 0
  }
}

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

400 — некорректный размер страницы:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "limit must be positive and offset nonnegative safe integers"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректный тип или форма параметра
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный или повторяющийся параметр запроса
HTTP401 КодMISSING_API_KEY ОписаниеНе передан API-ключ
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет токенов Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеНет права на операцию в Битрикс24
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеВозможность выключена или недоступна на портале. Целевое обновление указано в error.release
HTTP422 КодBITRIX_ERROR ОписаниеОтказ Битрикс24. Причина в error.message
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 вернул некорректный ответ

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

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