## Список шаблонов

`GET /v1/bizproc-templates`

Возвращает шаблоны бизнес-процессов, заведённые на портале, с фильтрацией, сортировкой и пагинацией.

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `select` (query) | string | — | Поля через запятую: `id`, `moduleId`, `entity`, `documentType`, `autoExecute`, `name`, `description`, `modified`, `isModified`, `userId`. Без `select` возвращается полный набор объявленных полей, включая `id` |
| `filter` (query) | object | — | Фильтрация по полям [`GET /v1/bizproc-templates/fields`](./fields.md).<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[entity]=BizprocDocument`.<br>Значения `moduleId` и `entity` — первые два элемента `documentType`, они перечислены в [Загрузить шаблон](./create.md) |
| `order` (query) | object | — | Сортировка. Пример: `?order[id]=desc` |
| `limit` (query) | number | `50` | Количество записей в ответе. Ноль не означает «без ограничения» — он игнорируется, приходят 50 записей и предупреждение `LIMIT_ZERO_IGNORED` |
| `offset` (query) | number | `0` | Смещение выборки |

Для `limit` больше 50 запрос пагинируется на стороне сервера. Максимум — 5000 записей за вызов.

## Примеры

Читать шаблоны можно только ключом авторизации — оба примера отправляют ключ авторизации и заголовок `Authorization: Bearer`. Токен сессии выдаёт OAuth-авторизация и живёт 24 часа без продления — [Передача ключа](/docs/keys-auth#передача-ключа).

### curl — ключ авторизации

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/bizproc-templates?select=id,name,moduleId,entity,autoExecute&limit=2" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — ключ авторизации

```javascript
const params = new URLSearchParams({
  select: 'id,name,moduleId,entity,autoExecute',
  limit: '2',
})

const res = await fetch(`https://vibecode.bitrix24.tech/v1/bizproc-templates?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()
console.log(`Шаблонов на портале: ${meta.total}`)
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив шаблонов. Состав полей элемента определяется параметром `select`, полная схема — [Поля шаблона](./fields.md) |
| `meta.total` | number | Количество шаблонов, попавших под фильтр |
| `meta.hasMore` | boolean | Есть ли записи за пределами `limit` |
| `meta.warnings` | array | Предупреждения о разборе запроса. Каждое — объект с полями `code`, `field` и `message`, например неизвестное имя поля в `select` с кодом `UNKNOWN_SELECT_FIELD` |

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

```json
{
  "success": true,
  "data": [
    {
      "id": 23,
      "name": "Согласование договора",
      "moduleId": "lists",
      "entity": "BizprocDocument",
      "autoExecute": 1
    },
    {
      "id": 25,
      "name": "Заявка на закупку",
      "moduleId": "lists",
      "entity": "BizprocDocument",
      "autoExecute": 1
    }
  ],
  "meta": {
    "total": 81,
    "hasMore": true
  }
}
```

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

403 — запрос отправлен API-ключом:

```json
{
  "success": false,
  "error": {
    "code": "OAUTH_REQUIRED",
    "message": "bizproc-templates require an OAuth app key (vibe_app_*) with an Authorization: Bearer session — a personal vibe_api_* key lacks the per-user OAuth context Bitrix24 needs for these methods. Create an OAuth app (POST /v1/apps) and retry with its key. On this 403 switch keys — do NOT delete or recreate the app (that discards anything already registered under it, e.g. a bizproc robot you just registered)."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_FILTER_OPERATOR` | Неизвестный оператор в фильтре. Сообщение перечисляет поддерживаемые операторы |
| 400 | `INVALID_FILTER_OPERATOR` | Логический ключ `$or` или `$and` в фильтре. Условие ИЛИ задаётся оператором `$in` для одного поля или параллельными запросами через [`POST /v1/batch`](/docs/batch), условие И — соседними ключами одного фильтра |
| 403 | `OAUTH_REQUIRED` | Запрос отправлен API-ключом. Читать шаблоны можно только ключом авторизации |
| 401 | `TOKEN_MISSING` | Ключ авторизации без заголовка `Authorization: Bearer` |
| 401 | `WRONG_AUTH_SCHEME` | Ключ авторизации отправлен в заголовке `Authorization: Bearer`. Сам ключ передаётся в `X-Api-Key`, а `Authorization: Bearer` несёт токен сессии |
| 401 | `INVALID_SESSION` | Токен сессии истёк или недействителен — пройдите авторизацию заново |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `bizproc` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

**Файл шаблона в ответе не приходит.** Содержимое `.bpt`, переданное при создании в поле `templateData`, обратно через API не читается — ни в списке, ни через `select`. Сохраняйте исходный файл на своей стороне.

**Поле `documentType` собирается из `moduleId` и `entity`.** Запрашивайте все три поля вместе — иначе первые два элемента массива приходят как `null`: `select=id,documentType` вернёт `[null, null, "iblock_19"]`, а `select=id,documentType,moduleId,entity` — `["lists", "BizprocDocument", "iblock_19"]`.

**Неизвестное имя поля в `select`, `filter` или `order` не вызывает ошибку.** Ответ приходит с кодом `200`, неизвестное имя отбрасывается: в `filter` выборка не сужается, в `order` порядок не меняется, в `select` поле отсутствует в записях, а в `meta.warnings` приходит предупреждение с кодом `UNKNOWN_SELECT_FIELD`. Имена полей сверяйте со строкой `select` в таблице параметров или со схемой [`GET /v1/bizproc-templates/fields`](./fields.md).

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

- [Поиск шаблонов](/docs/entities/bizproc-templates/search)
- [Поля шаблона](/docs/entities/bizproc-templates/fields)
- [Загрузить шаблон](/docs/entities/bizproc-templates/create)
- [Обновить шаблон](/docs/entities/bizproc-templates/update)
- [Удалить шаблон](/docs/entities/bizproc-templates/delete)
- [Синтаксис фильтрации](/docs/filtering)
- [Ключи и авторизация](/docs/keys-auth)