## Получить поле контракта формы

`GET /v1/crm-forms/fields/:name`

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

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `name` (path) | string | да | Имя свойства формы, например `name`, `fields`, `appearance`, `analytics`, `integrations` или `spamProtection`. Список: `data[].name` в [Поля контракта формы](/docs/entities/crm-forms/fields) |
| `select` (query) | string | нет | Свойства метаданных через запятую, например `name,type,multiple` |

## Примеры

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

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

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

```bash
curl "https://vibecode.bitrix24.tech/v1/crm-forms/fields/analytics" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

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

const { success, data } = await res.json()
console.log('Тип свойства:', data.type)
```

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

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

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | object | Описание свойства формы. Поля объекта те же, что у элемента `data[]` в [Поля контракта формы](/docs/entities/crm-forms/fields) |

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

```json
{
  "success": true,
  "data": {
    "name": "analytics",
    "type": "object",
    "elementType": null,
    "multiple": false,
    "title": "analytics",
    "description": null,
    "validationRules": [],
    "requiredGroups": null,
    "filterable": false,
    "sortable": false,
    "editable": false
  }
}
```

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

404 — свойства с таким именем нет:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Поле `unknownProperty` не найдено",
    "b24Code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 404 | `ENTITY_NOT_FOUND` | Свойства с таким `name` нет. Исходный код — в `error.b24Code` |
| 400 | `INVALID_PARAMS` | Передан неизвестный параметр запроса |
| 400 | `INVALID_PARAMS` | `select` не является строкой или массивом строк |
| 400 | `INVALID_PARAMS` | Битрикс24 отклонил проекцию. Исходный код — в `error.b24Code` |
| 403 | `BITRIX_ACCESS_DENIED` | У пользователя Битрикс24 нет прав на формы |
| 403 | `BITRIX_INSUFFICIENT_SCOPE` | У токена Битрикс24 нет необходимого скоупа |
| 409 | `CRM_FORM_REST_NOT_ENABLED` | REST-методы CRM-форм недоступны на этом портале Битрикс24. Это не означает отсутствие отдельной формы |
| 400–599 | `CRM_FORM_*` | Отказ по правилам форм. Код и HTTP-статус сохранены, исходный код — в `error.b24Code` |
| 422 | `BITRIX_ERROR` | Другой отказ Битрикс24. Причина — в `error.message`, исходный код — в `error.b24Code` |
| 429 | `RATE_LIMITED` | Превышена частота запросов. Учитывайте заголовок `Retry-After` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 вернул ответ в неожиданном виде |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен: ошибка сервера или разрыв соединения |
| 503 | `BITRIX_TIMEOUT` | Битрикс24 не ответил вовремя. Чтение можно повторить |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | У ключа не настроен доступ к Битрикс24 |
| 403 | `SCOPE_DENIED` | У API-ключа Вайбкод нет скоупа `crm` |

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

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

- [Поля контракта формы](/docs/entities/crm-forms/fields)
- [Получить форму](/docs/entities/crm-forms/get)
- [Создать форму](/docs/entities/crm-forms/create)
- [CRM-формы](/docs/entities/crm-forms)