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

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

GET /v1/statuses/:id

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

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID записи справочника. Список: GET /v1/statuses

Примеры

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()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеЗапись справочника (все поля — см. Поля справочника)

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

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

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

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

JSON
{
  "success": false,
  "error": { "code": "ENTITY_NOT_FOUND", "message": "CRM Status is not found." }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не целое неотрицательное число. Сообщение: id must be a non-negative integer
HTTP404 КодENTITY_NOT_FOUND ОписаниеЗапись с указанным id не найдена
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key

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

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