## Получить одно поле генерации

`GET /v1/sites/ai/fields/:name`

Получает определение поля по имени.

## Параметры

| Параметр | Тип | Обяз. | По умолч. | Описание |
|---|---|---|---|---|
| `name` (path) | string | да | — | Имя поля из [словаря](./fields.md) |

## Примеры

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

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/sites/ai/fields/id" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/sites/ai/fields/id" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch("https://vibecode.bitrix24.tech/v1/sites/ai/fields/id", {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY"
  }
});
const result = await res.json();
console.log(result);
```

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

```javascript
const res = await fetch("https://vibecode.bitrix24.tech/v1/sites/ai/fields/id", {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN"
  }
});
const result = await res.json();
console.log(result);
```

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

| Поле | Тип | Описание |
|---|---|---|
| `success` | boolean | `true` при успехе |
| `data` | object | Определение поля |
| `data.name` | string | Имя поля |
| `data.type` | string | Тип значения |
| `data.title` | string | Название поля |
| `data.description` | string \| null | Описание поля или null |
| `data.validationRules` | array | Правила проверки |
| `data.requiredGroups` | array \| null | Группы обязательности или null |
| `data.filterable` | boolean | Доступность фильтрации |
| `data.sortable` | boolean | Доступность сортировки |
| `data.editable` | boolean | Доступность изменения |
| `data.editableGroups` | array \| null | Группы изменения или null |
| `data.multiple` | boolean | Множественное значение |
| `data.elementType` | string \| null | Тип элемента или null |

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

```json
{
  "success": true,
  "data": {
    "name": "id",
    "type": "int",
    "title": "Site generation identifier",
    "description": null,
    "validationRules": [],
    "requiredGroups": null,
    "filterable": false,
    "sortable": false,
    "editable": false,
    "editableGroups": null,
    "multiple": false,
    "elementType": null
  }
}
```

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

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

## Ошибки

| HTTP | Код | Описание |
|---|---|---|
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 отказал в запросе |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `INVALID_API_KEY` | Платформа не знает переданную строку ключа |
| 401 | `TOKEN_MISSING` | Ключ приложения `vibe_app_*` передан без заголовка `Authorization: Bearer` с токеном сессии |
| 401 | `TOKEN_MISSING` | У личного ключа `vibe_api_*` нет вебхука портала. Причина приходит в `error.details` |
| 403 | `SCOPE_DENIED` | Ключу не выдан скоуп landing |

[Общие ошибки](/docs/errors).

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

- [Генерация сайта с ИИ](../ai.md)
