## Получить поле

`GET /v1/lists/:iblockId/fields/:fieldId`

Возвращает описание одного поля списка по его идентификатору. Подходит, когда нужны параметры конкретного поля, а не всего набора.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `iblockId` (path) | string | да | Идентификатор списка. Числовой `IBLOCK_ID` или символьный `IBLOCK_CODE`. Список — `GET /v1/lists` |
| `fieldId` (path) | string | да | Идентификатор поля. У пользовательских — `PROPERTY_<число>`, у системных — символьный код, например `NAME`. Значения — в [Поля списка](./list.md), ключ `FIELD_ID` |
| `iblockTypeId` (query) | string | нет | Тип инфоблока. Значения:<br>`lists` — обычные списки, по умолчанию<br>`lists_socnet` — списки рабочих групп<br>`bitrix_processes` — служебные бизнес-процессы<br>`structure` — тип структуры компании (здесь лежит штатный инфоблок графика отсутствий `absence`) |

## Примеры

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

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

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

```bash
curl https://vibecode.bitrix24.tech/v1/lists/121/fields/PROPERTY_1149 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/121/fields/PROPERTY_1149', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
const field = Object.values(data)[0]
console.log('Поле:', field.NAME)
```

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

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

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

Поле `data` — объект с единственным ключом. Ключ — код типа поля, значение — описание поля. Ниже перечислены ключи описания.

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | object | Объект с единственным ключом — кодом типа поля. Значение — описание поля |
| `data.<TYPE>.FIELD_ID` | string | Идентификатор поля. У пользовательских — `PROPERTY_<число>`, у системных — символьный код |
| `data.<TYPE>.NAME` | string | Название поля для отображения |
| `data.<TYPE>.TYPE` | string | Код типа поля. Расшифровка кодов — [Типы полей](./field-types.md) |
| `data.<TYPE>.IS_REQUIRED` | string | Обязательность заполнения: `Y` или `N` |
| `data.<TYPE>.MULTIPLE` | string | Допускает несколько значений: `Y` или `N` |
| `data.<TYPE>.SORT` | number | Порядок сортировки в форме |
| `data.<TYPE>.DEFAULT_VALUE` | string или null | Значение по умолчанию |
| `data.<TYPE>.CODE` | string или null | Символьный код поля. Есть только у пользовательских полей |
| `data.<TYPE>.ID` | string | Числовой идентификатор пользовательского поля строкой. У системных полей отсутствует |
| `data.<TYPE>.PROPERTY_TYPE` | string или boolean | Базовый тип пользовательского поля. У системных полей приходит `false` |
| `data.<TYPE>.SETTINGS` | object или boolean | Параметры отображения поля в формах. У системных полей приходит `false` |

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

```json
{
  "success": true,
  "data": {
    "S": {
      "FIELD_ID": "PROPERTY_1149",
      "SORT": 10,
      "NAME": "Статус",
      "IS_REQUIRED": "N",
      "MULTIPLE": "N",
      "DEFAULT_VALUE": null,
      "TYPE": "S",
      "PROPERTY_TYPE": "S",
      "PROPERTY_USER_TYPE": false,
      "CODE": "STATUS",
      "ID": "1149",
      "LINK_IBLOCK_ID": null,
      "ROW_COUNT": "1",
      "COL_COUNT": "30",
      "USER_TYPE_SETTINGS": null,
      "SETTINGS": false
    }
  }
}
```

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

404 — поле не найдено:

```json
{
  "success": false,
  "error": {
    "code": "FIELD_NOT_FOUND",
    "message": "Field not found"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_IBLOCK_TYPE` | `iblockTypeId` не входит в список допустимых типов |
| 404 | `FIELD_NOT_FOUND` | Поля с указанным `fieldId` в списке нет |
| 403 | `BITRIX_ACCESS_DENIED` | Нет прав на просмотр списка либо списка с указанным идентификатором не существует |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `lists` |
| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |
| 409 | `LISTS_MODULE_NOT_ENABLED` | На портале не подключён модуль списков |

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

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

**Ключ верхнего уровня в ответе — код типа поля, а не `FIELD_ID`.** У операции [Поля списка](./list.md) ключ верхнего уровня — идентификатор поля `FIELD_ID`, здесь же — код типа поля, например `S`. Сам идентификатор передаётся в пути и повторяется внутри описания в `data.<TYPE>.FIELD_ID`. Чтобы достать описание, возьмите первое значение объекта: `Object.values(data)[0]`.

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

- [Поля списка](/docs/lists/fields/list)
- [Типы полей](/docs/lists/fields/field-types)
- [Обновить поле](/docs/lists/fields/update)
- [Поля списка](/docs/lists/fields)