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

`GET /v1/workflows`

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

## Параметры

| Параметр | Тип | Описание |
|----------|-----|---------|
| `templateId` | number | Фильтр по ID шаблона бизнес-процесса |
| `startedBy` | number | Фильтр по ID пользователя, запустившего процесс |
| `limit` | number | Количество возвращаемых записей. По умолчанию 50, максимум 500. Значение вне диапазона приводится к ближайшей границе |
| `offset` | number | Смещение для пагинации. По умолчанию 0 |

При `limit > 50` ответ собирается из нескольких последовательных чтений по 50 записей — время ответа растёт вместе с `limit`.

## Примеры

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

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

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

```bash
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[].modifiedAt` | string | Дата последнего изменения (ISO 8601) |
| `data[].ownedUntil` | string \| null | Дата блокировки на выполнение текущего шага. `null`, если не заблокирован |
| `data[].moduleId` | string | Модуль сущности (например `crm`) |
| `data[].entity` | string | Класс документа (например `CCrmDocumentDeal`) |
| `data[].documentId` | string | Идентификатор документа в формате `TYPENAME_ID` (например `DEAL_5141`) |
| `data[].startedAt` | string | Дата запуска (ISO 8601) |
| `data[].startedBy` | string | ID пользователя, запустившего процесс (`"0"` — системный запуск) |
| `data[].templateId` | string | ID шаблона бизнес-процесса |
| `meta.total` | number | Общее количество найденных экземпляров |

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

```json
{
  "success": true,
  "data": [
    {
      "id": "69f0c2d5ade389.22457798",
      "modifiedAt": "2026-04-28T17:23:17+03:00",
      "ownedUntil": null,
      "moduleId": "crm",
      "entity": "CCrmDocumentDeal",
      "documentId": "DEAL_5141",
      "startedAt": "2026-04-28T17:23:17+03:00",
      "startedBy": "0",
      "templateId": "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 — [Ошибки](/docs/errors).

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

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

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

- [Запустить бизнес-процесс](/docs/automation/workflows/start)
- [Завершить бизнес-процесс](/docs/automation/workflows/terminate)
- [Бизнес-процессы](/docs/automation/workflows)