## Get field

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

Returns the description of a single list field by its identifier. Useful when you need the parameters of a specific field rather than the whole set.

## Parameters

| Parameter | Type | Required | Default | Description |
|----------|-----|:-----:|:---------:|---------|
| `iblockId` (path) | string | yes | — | List identifier or symbolic code. Values come from the `ID` or `CODE` fields of [List lists](/docs/lists/lists/list) |
| `fieldId` (path) | string | yes | — | Field identifier from `FIELD_ID` in [List fields](./list.md). For user fields — `PROPERTY_<number>`, for system fields — a symbolic code, for example `NAME` |
| `iblockTypeId` (query) | string | no | `lists` | Infoblock type. Values:<br>`lists` — regular lists<br>`lists_socnet` — workgroup lists<br>`bitrix_processes` — service workflows<br>`structure` — company structure type containing the built-in absence calendar infoblock `absence` |
| `socnetGroupId` (query) | number | no | — | Workgroup identifier for lists of type `lists_socnet`. A positive integer from the `id` field of [List workgroups](/docs/entities/workgroups/list) |


## Examples

### curl — personal key

```bash
curl https://vibecode.bitrix24.com/v1/lists/153/fields/PROPERTY_1207 \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl https://vibecode.bitrix24.com/v1/lists/153/fields/PROPERTY_1207 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/lists/153/fields/PROPERTY_1207', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
const field = Object.values(data)[0]
console.log('Field:', field.NAME)
```

### JavaScript — OAuth application

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

## Response fields

The `data` field contains the description of a single field, keyed by its type. In the path `data.<TYPE>`, `<TYPE>` is replaced by the type code, for example `N` or `S:HTML`. The [List fields](./list.md) method uses `FIELD_ID` as the key. The response has no `meta` field.

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | object | Object with a single key — the field type code. The value is the field description object |
| `data.<TYPE>.FIELD_ID` | string | Field identifier from [List fields](./list.md). For user fields — `PROPERTY_<number>`, for system fields — a symbolic code, for example `NAME` |
| `data.<TYPE>.NAME` | string | Display name of the field |
| `data.<TYPE>.TYPE` | string | Field type code. Code reference — [Field types](./field-types.md) |
| `data.<TYPE>.IS_REQUIRED` | string | Whether the field is required: `Y` or `N` |
| `data.<TYPE>.MULTIPLE` | string | Allows multiple values: `Y` or `N` |
| `data.<TYPE>.SORT` | number | Sort order in the form |
| `data.<TYPE>.DEFAULT_VALUE` | string, object or null | Default value. The format depends on `TYPE`: for example, `N` uses a string containing a number, while `S:HTML` uses an object with the keys `TYPE` and `TEXT` |
| `data.<TYPE>.CODE` | string or null | Symbolic code of the user field. `null` if not set. Absent for system fields |
| `data.<TYPE>.ID` | string | Numeric identifier of the user field as a string — the numeric part of `FIELD_ID`. Absent for system fields |
| `data.<TYPE>.PROPERTY_TYPE` | string or boolean | Base type of the user field: `S`, `N`, `L`, `F`, `G` or `E`. For system fields — `false` |
| `data.<TYPE>.PROPERTY_USER_TYPE` | object or boolean | Description of the extended property type. Contains its base type `PROPERTY_TYPE`, code `USER_TYPE`, name `DESCRIPTION`, and handlers, which vary by type. `false` if there is no extended type |
| `data.<TYPE>.LINK_IBLOCK_ID` | string or null | Linked list identifier from the `ID` field of [List lists](/docs/lists/lists/list). `null` if there is no link. Absent for system fields |
| `data.<TYPE>.ROW_COUNT` | string | Input field height in rows. Absent for system fields |
| `data.<TYPE>.COL_COUNT` | string | Input field width in characters. Absent for system fields |
| `data.<TYPE>.USER_TYPE_SETTINGS` | object or null | Extended property type settings. The fields depend on `TYPE`, for example `height` for `S:HTML`. `null` if there are no settings. Absent for system fields |
| `data.<TYPE>.SETTINGS` | object or boolean | Field display settings in forms. `false` if no settings are configured. A system field can also return an object |
| `data.<TYPE>.SETTINGS.SHOW_ADD_FORM` | string | Show the field when adding an element: `Y` or `N` |
| `data.<TYPE>.SETTINGS.SHOW_EDIT_FORM` | string | Show the field when editing an element: `Y` or `N` |
| `data.<TYPE>.SETTINGS.ADD_READ_ONLY_FIELD` | string | The field is read-only when adding an element: `Y` or `N` |
| `data.<TYPE>.SETTINGS.EDIT_READ_ONLY_FIELD` | string | The field is read-only when editing an element: `Y` or `N` |
| `data.<TYPE>.SETTINGS.SHOW_FIELD_PREVIEW` | string | Show the field when previewing an element: `Y` or `N` |
| `data.<TYPE>.DISPLAY_VALUES_FORM` | object or array | Choices for types `L`, `G`, `E` and `E:...`: the key is the identifier of an option, section or element; the value is its name. Returns an empty array `[]` if there are no choices |

To get the field description, use `Object.values(data)[0]`.

## Response example

```json
{
  "success": true,
  "data": {
    "N": {
      "FIELD_ID": "PROPERTY_1207",
      "SORT": 20,
      "NAME": "Priority",
      "IS_REQUIRED": "N",
      "MULTIPLE": "N",
      "DEFAULT_VALUE": "0",
      "TYPE": "N",
      "PROPERTY_TYPE": "N",
      "PROPERTY_USER_TYPE": false,
      "CODE": "PRIORITY",
      "ID": "1207",
      "LINK_IBLOCK_ID": null,
      "ROW_COUNT": "1",
      "COL_COUNT": "30",
      "USER_TYPE_SETTINGS": null,
      "SETTINGS": {
        "SHOW_ADD_FORM": "Y",
        "SHOW_EDIT_FORM": "Y",
        "ADD_READ_ONLY_FIELD": "N",
        "EDIT_READ_ONLY_FIELD": "N",
        "SHOW_FIELD_PREVIEW": "N"
      }
    }
  }
}
```

## Error response example

404 — field not found:

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

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `INVALID_IBLOCK_TYPE` | `iblockTypeId` is not one of the allowed types |
| 404 | `FIELD_NOT_FOUND` | No field with the specified `fieldId` exists in the list |
| 403 | `BITRIX_ACCESS_DENIED` | No permission to view the list |
| 404 | `LIST_NOT_FOUND` | No list with the specified `iblockId` exists |
| 409 | `LISTS_MODULE_NOT_ENABLED` | The lists module is not enabled on the portal |
| 403 | `SCOPE_DENIED` | The key is missing the `lists` scope |
| 401 | `TOKEN_MISSING` | The key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## See also

- [List fields](/docs/lists/fields/list)
- [Field types](/docs/lists/fields/field-types)
- [Update a field](/docs/lists/fields/update)
- [List fields](/docs/lists/fields)