#Список справочников

GET /v1/statuses

Возвращает записи справочников CRM. Используйте filter[entityId] для выбора конкретного типа.

#Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей (до 5000). При limit > 50 авто-пагинация
offset number 0 Пропустить N записей
select string — Выборка полей: ?select=id,name,entityId
order object — Сортировка: ?order[sort]=asc
filter object — Фильтрация по полям GET /v1/statuses/fields.
Синтаксис фильтрации. Пример: ?filter[entityId]=DEAL_STAGE

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/statuses?filter[entityId]=DEAL_STAGE&order[sort]=asc" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/statuses?filter[entityId]=DEAL_STAGE&order[sort]=asc" \
  -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?filter[entityId]=DEAL_STAGE&order[sort]=asc', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data, meta } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses?filter[entityId]=DEAL_STAGE&order[sort]=asc', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data, meta } = await res.json()

#Поля ответа

Поле Тип Описание
data[].id number ID записи
data[].entityId string Тип справочника (DEAL_STAGE, SOURCE, CONTACT_TYPE и др.)
data[].statusId string Символьный код значения
data[].name string Название
data[].nameInit string Исходное название
data[].sort number Сортировка
data[].SYSTEM string Системная запись (Y/N)
data[].CATEGORY_ID number/null ID категории
data[].color string Цвет (HEX)
data[].semantics string/null Семантика: S (успех), F (провал), P (в работе)

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "entityId": "DEAL_STAGE",
      "statusId": "NEW",
      "name": "Новая",
      "sort": 10,
      "color": "22B9FF",
      "semantics": "P"
    },
    {
      "id": 2,
      "entityId": "DEAL_STAGE",
      "statusId": "WON",
      "name": "Сделка успешна",
      "sort": 50,
      "color": "7BD500",
      "semantics": "S"
    }
  ],
  "meta": { "total": 12, "hasMore": false }
}

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

JSON 
{
  "success": false,
  "error": { "code": "SCOPE_DENIED", "message": "This endpoint requires 'crm' scope" }
}

#Ошибки

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

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

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