#Поля справочника

GET /v1/statuses/fields

Возвращает описание всех полей сущности с типами и атрибутами.

#Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/statuses/fields" \
  -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/fields', {
  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/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()

#Поля ответа

Поле Тип RO Описание
id number да ID записи
entityId string Тип справочника (DEAL_STAGE, SOURCE и др.)
statusId string Символьный код значения
name string Название
nameInit string Исходное название
sort number Сортировка
color string Цвет (HEX)
semantics string Семантика: S (успех), F (провал), P (в работе)
system boolean да Системное значение (нельзя изменить/удалить)
categoryId number ID воронки (для entityId вида DEAL_STAGE_N)

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

GET /v1/statuses/fields возвращает описания полей под ключом data.fields (имена — camelCase, как в ответах API), где каждое поле — { type, readonly }. Плюс data.batch со списком доступных batch-операций.

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityId": { "type": "string", "readonly": false },
      "statusId": { "type": "string", "readonly": false },
      "name": { "type": "string", "readonly": false },
      "nameInit": { "type": "string", "readonly": false },
      "sort": { "type": "number", "readonly": false },
      "color": { "type": "string", "readonly": false },
      "semantics": { "type": "string", "readonly": false },
      "system": { "type": "boolean", "readonly": true },
      "categoryId": { "type": "number", "readonly": false }
    },
    "batch": ["create", "update", "delete"]
  }
}

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

404 — не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

#Ошибки

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

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

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