## Поля шаблонов реквизитов

`GET /v1/requisite-presets/fields`

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

## Примеры

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

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

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

```bash
curl "https://vibecode.bitrix24.tech/v1/requisite-presets/fields" \
  -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/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data } = await res.json()
console.log('Всего полей:', Object.keys(data.fields).length)
```

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

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

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

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

Ответ — объект `{ success, data: { fields: {...} } }`. Каждое поле описано объектом `{ type, readonly }`.

| Поле | Битрикс24 | Тип | RO | Описание |
|------|-----------|-----|:--:|---------|
| `id` | `ID` | number | да | Идентификатор шаблона |
| `entityTypeId` | `ENTITY_TYPE_ID` | number | | Тип сущности — всегда `8`, реквизит. Задаётся при создании шаблона. В схеме помечен флагом `createOnly`, передача в теле обновления отклоняется с `400 READONLY_FIELD` |
| `countryId` | `COUNTRY_ID` | number | | Идентификатор страны набора полей. Задаётся при создании шаблона. В схеме помечен флагом `createOnly`, передача в теле обновления отклоняется с `400 READONLY_FIELD` |
| `name` | `NAME` | string | | Название шаблона |
| `active` | `ACTIVE` | boolean | | Активен ли шаблон |
| `sort` | `SORT` | number | | Порядок сортировки |
| `xmlId` | `XML_ID` | string | | Внешний идентификатор для синхронизации |
| `createdAt` | `DATE_CREATE` | datetime | да | Дата создания |
| `updatedAt` | `DATE_MODIFY` | datetime | да | Дата последнего изменения |
| `createdBy` | `CREATED_BY_ID` | number | да | Идентификатор создателя |
| `modifyBy` | `MODIFY_BY_ID` | number | да | Идентификатор последнего редактора |

`xmlId`, `updatedAt`, `modifyBy` могут быть `null`. Поле `createdBy` равно `0` у шаблонов, созданных системой.

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

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityTypeId": { "type": "number", "readonly": false, "createOnly": true },
      "countryId": { "type": "number", "readonly": false, "createOnly": true },
      "name": { "type": "string", "readonly": false },
      "active": { "type": "boolean", "readonly": false },
      "sort": { "type": "number", "readonly": false },
      "xmlId": { "type": "string", "readonly": false },
      "createdAt": { "type": "datetime", "readonly": true },
      "updatedAt": { "type": "datetime", "readonly": true },
      "createdBy": { "type": "number", "readonly": true },
      "modifyBy": { "type": "number", "readonly": 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-ключ не имеет настроенных токенов |

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

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

- [Получить шаблон](/docs/entities/requisite-presets/get)
- [Создать шаблон](/docs/entities/requisite-presets/create)
- [Список шаблонов](/docs/entities/requisite-presets/list)
- [Шаблоны реквизитов](/docs/entities/requisite-presets)