#Список запущенных бизнес-процессов

GET /v1/workflows

Возвращает запущенные экземпляры бизнес-процессов на портале, отсортированные по дате изменения (сначала новые).

#Параметры

Параметр Тип Описание
templateId number Фильтр по ID шаблона бизнес-процесса
startedBy number Фильтр по ID пользователя, запустившего процесс
offset number Смещение для пагинации. По умолчанию 0

#Примеры

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workflows', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data, meta } = await res.json()
console.log(`Процессов: ${meta.total}`, data)

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

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив экземпляров бизнес-процессов
data[].ID string Уникальный идентификатор экземпляра
data[].MODIFIED string Дата последнего изменения (ISO 8601)
data[].OWNED_UNTIL string | null Дата блокировки на выполнение текущего шага; null если не заблокирован
data[].MODULE_ID string Модуль сущности (например crm)
data[].ENTITY string Класс документа (например CCrmDocumentDeal)
data[].DOCUMENT_ID string Идентификатор документа в формате TYPENAME_ID (например DEAL_5141)
data[].STARTED string Дата запуска (ISO 8601)
data[].STARTED_BY string ID пользователя, запустившего процесс ("0" — системный запуск)
data[].TEMPLATE_ID string ID шаблона бизнес-процесса
meta.total number Общее количество найденных экземпляров

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

JSON 
{
  "success": true,
  "data": [
    {
      "ID": "69f0c2d5ade389.22457798",
      "MODIFIED": "2026-04-28T17:23:17+03:00",
      "OWNED_UNTIL": null,
      "MODULE_ID": "crm",
      "ENTITY": "CCrmDocumentDeal",
      "DOCUMENT_ID": "DEAL_5141",
      "STARTED": "2026-04-28T17:23:17+03:00",
      "STARTED_BY": "0",
      "TEMPLATE_ID": "713"
    }
  ],
  "meta": {
    "total": 1
  }
}

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

403 — нет скоупа bizproc:

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

#Ошибки

HTTP Код Описание
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный или недействительный API-ключ
401 TOKEN_MISSING У ключа нет подключённых токенов Битрикс24
401 TOKEN_EXPIRED Пользовательская сессия OAuth истекла — повторите авторизацию через /v1/oauth/authorize
403 SCOPE_DENIED Ключу не хватает скоупа bizproc
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе
429 RATE_LIMITED Превышен лимит запросов. Повторите через 1–2 секунды
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

#Известные особенности

  • DOCUMENT_ID — строка, не массив. Поле возвращается строкой в формате "TYPENAME_ID" (например "DEAL_5141"), а не массивом. При запуске процесса через POST /v1/workflows/start идентификатор документа передаётся в Битрикс24 массивом, однако в ответе этого эндпоинта он нормализован к строке.

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