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

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 Исходное название
sort number Сортировка
SYSTEM string Системная запись (Y/N)
CATEGORY_ID number/null ID категории
color string Цвет (HEX)
semantics string/null Семантика: S (успех), F (провал), P (в работе)

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

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "entityId": "DEAL_STAGE",
    "statusId": "NEW",
    "name": "Новая",
    "nameInit": "Новая",
    "sort": 10,
    "color": "22B9FF",
    "semantics": "P"
  }
}

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

JSON 
{
  "success": false,
  "error": { "code": "NOT_FOUND", "message": "Status not found" }
}

#Ошибки

HTTP Код Описание
404 NOT_FOUND Запись не найдена
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING Не передан API-ключ

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

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