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

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

GET /v1/statuses/:id

Возвращает одну запись справочника CRM по ID.

Параметры пути

Параметр	Тип	Описание
`id`	number	ID записи справочника

Примеры

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

Terminal

curl "https://vibecode.bitrix24.tech/v1/statuses/1" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal

curl "https://vibecode.bitrix24.tech/v1/statuses/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses/1', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses/1', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()

Поля ответа

Поле	Тип	Описание
`id`	number	ID записи
`entityId`	string	Тип справочника (DEAL_STAGE, SOURCE, CONTACT_TYPE и др.)
`statusId`	string	Символьный код значения
`name`	string	Название
`nameInit`	string/null	Исходное название
`sort`	number	Сортировка
`system`	boolean	Системное значение. Только для чтения
`categoryId`	number/null	ID воронки. Заполняется для справочников вида `DEAL_STAGE_N`, иначе `0` или `null`
`color`	string/null	Цвет в HEX с ведущей `#`
`semantics`	string/null	Семантика: `S` — успех, `F` — провал. `null` — стадия «в работе» или справочник без семантики
`extra`	object/null	Дополнительные данные справочников со стадиями — `STATUS`, `DEAL_STAGE`, `DEAL_STAGE_N`, `QUOTE_STATUS`. Вложенные ключи `SEMANTICS` и `COLOR`, значения `SEMANTICS` — в Полях справочника. Только для чтения, у остальных справочников отсутствует

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

JSON

{
  "success": true,
  "data": {
    "id": 101,
    "entityId": "DEAL_STAGE",
    "statusId": "NEW",
    "name": "Новая",
    "nameInit": "Новая",
    "sort": 10,
    "system": true,
    "categoryId": null,
    "color": "#39A8EF",
    "semantics": null,
    "extra": {
      "SEMANTICS": "process",
      "COLOR": "#39A8EF"
    }
  }
}

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