## Список шаблонов реквизитов

`GET /v1/requisite-presets`

Возвращает список шаблонов реквизитов с поддержкой фильтрации, сортировки и авто-пагинации. Используется для получения доступных шаблонов наборов полей перед созданием реквизита.

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Количество записей (до 5000). При `limit > 50` Вайбкод автоматически запрашивает несколько страниц у Битрикс24 |
| `offset` | number | `0` | Пропустить N записей. При `offset > 0` рекомендуется `limit ≤ 500` |
| `select` | string | — | Выборка полей: `?select=id,name,active` |
| `order` | object | — | Сортировка: `?order[sort]=asc` или `?order[id]=desc` |
| `filter` | object | — | Фильтрация по полям `GET /v1/requisite-presets/fields`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[active]=true&filter[countryId]=1` |

### Пагинация

При `limit > 50` Вайбкод автоматически пагинирует запрос на стороне сервера. Максимум — 5000 записей за вызов. Если под фильтр попадает больше, в `meta.hasMore` придёт `true`.

## Примеры

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

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

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

```bash
curl "https://vibecode.bitrix24.tech/v1/requisite-presets" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} шаблонов`)
```

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

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

const { success, data, meta } = await res.json()
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив шаблонов (все поля — см. [Поля шаблонов реквизитов](/docs/entities/requisite-presets/fields)) |
| `meta.total` | number | Общее количество записей, соответствующих фильтру |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |

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

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "entityTypeId": 8,
      "countryId": 1,
      "name": "Организация",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-08-13T14:34:26.000Z",
      "createdBy": 0,
      "modifyBy": 1,
      "active": true,
      "sort": 510,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#"
    },
    {
      "id": 3,
      "entityTypeId": 8,
      "countryId": 1,
      "name": "ИП",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-07-20T14:39:09.000Z",
      "createdBy": 0,
      "modifyBy": 1,
      "active": false,
      "sort": 520,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_INDIVIDUAL#"
    },
    {
      "id": 5,
      "entityTypeId": 8,
      "countryId": 1,
      "name": "Физ. лицо",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-08-13T14:34:34.000Z",
      "createdBy": 0,
      "modifyBy": null,
      "active": true,
      "sort": 530,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_PERSON#"
    }
  ],
  "meta": {
    "total": 14,
    "hasMore": true
  }
}
```

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

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

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 400 | `INVALID_FILTER` | Ошибка в синтаксисе фильтра |

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

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

**Поле `entityTypeId` всегда равно `8`.** Все шаблоны относятся к типу сущности «реквизит» — `entityTypeId: 8`. Значение не изменяется и не передаётся в фильтре как различающий признак.

**Поле `countryId`.** Российские шаблоны имеют `countryId: 1`. На портале с региональными шаблонами (Казахстан, Украина, Польша и др.) в списке появятся шаблоны с другими значениями.

**Неактивные шаблоны включаются в список.** Шаблон с `active: false` возвращается в списке по умолчанию. Чтобы получить только активные шаблоны, передайте `filter[active]=true`.

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

- [Поиск шаблонов реквизитов](/docs/entities/requisite-presets/search)
- [Поля шаблонов реквизитов](/docs/entities/requisite-presets/fields)
- [Создать реквизит](/docs/entities/requisites/create)
- [Синтаксис фильтрации](/docs/filtering)
- [Entity API](/docs/entity-api)