## List fields

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

Returns descriptions of system and user fields of a list to prepare forms and requests for its elements.

## 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) |
| `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/149/fields \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl https://vibecode.bitrix24.com/v1/lists/149/fields \
  -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/149/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Field IDs:', Object.keys(data))
```

### JavaScript — OAuth application

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

## Response fields

The response contains a field dictionary without pagination. In the path `data.<FIELD_ID>`, `<FIELD_ID>` is replaced by a field identifier, for example `NAME` or `PROPERTY_1197`. The response has no `meta` field.

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | object | Dictionary: the key is the field identifier `FIELD_ID`, the value is its description object |
| `data.<FIELD_ID>.FIELD_ID` | string | Field identifier for [Get field](/docs/lists/fields/get). For user fields — `PROPERTY_<number>`, for system fields — a symbolic code, for example `NAME` |
| `data.<FIELD_ID>.NAME` | string | Display name of the field |
| `data.<FIELD_ID>.TYPE` | string | Field type code. Code reference — [Field types](./field-types.md) |
| `data.<FIELD_ID>.IS_REQUIRED` | string | Whether the field is required: `Y` or `N` |
| `data.<FIELD_ID>.MULTIPLE` | string | Allows multiple values: `Y` or `N` |
| `data.<FIELD_ID>.SORT` | number | Sort order in the form |
| `data.<FIELD_ID>.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.<FIELD_ID>.CODE` | string or null | Symbolic code of the user field. `null` if not set. Absent for system fields |
| `data.<FIELD_ID>.ID` | string | Numeric identifier of the user field as a string — the numeric part of `FIELD_ID`. Absent for system fields |
| `data.<FIELD_ID>.PROPERTY_TYPE` | string or boolean | Base type of the user field: `S`, `N`, `L`, `F`, `G` or `E`. For system fields — `false` |
| `data.<FIELD_ID>.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.<FIELD_ID>.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.<FIELD_ID>.ROW_COUNT` | string | Input field height in rows. Absent for system fields |
| `data.<FIELD_ID>.COL_COUNT` | string | Input field width in characters. Absent for system fields |
| `data.<FIELD_ID>.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.<FIELD_ID>.SETTINGS` | object or boolean | Field display settings in forms. `false` if no settings are configured. A system field can also return an object |
| `data.<FIELD_ID>.SETTINGS.SHOW_ADD_FORM` | string | Show the field when adding an element: `Y` or `N` |
| `data.<FIELD_ID>.SETTINGS.SHOW_EDIT_FORM` | string | Show the field when editing an element: `Y` or `N` |
| `data.<FIELD_ID>.SETTINGS.ADD_READ_ONLY_FIELD` | string | The field is read-only when adding an element: `Y` or `N` |
| `data.<FIELD_ID>.SETTINGS.EDIT_READ_ONLY_FIELD` | string | The field is read-only when editing an element: `Y` or `N` |
| `data.<FIELD_ID>.SETTINGS.SHOW_FIELD_PREVIEW` | string | Show the field when previewing an element: `Y` or `N` |
| `data.<FIELD_ID>.IBLOCK_ID` | number | Identifier of the list the field belongs to. Source — [List lists](/docs/lists/lists/list) |
| `data.<FIELD_ID>.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 iterate over field descriptions, use `Object.values(data)`. To get their identifiers, use `Object.keys(data)`.

## Response example

```json
{
  "success": true,
  "data": {
    "NAME": {
      "FIELD_ID": "NAME",
      "SORT": 10,
      "NAME": "Name",
      "IS_REQUIRED": "Y",
      "MULTIPLE": "N",
      "DEFAULT_VALUE": "",
      "TYPE": "NAME",
      "PROPERTY_TYPE": false,
      "PROPERTY_USER_TYPE": false,
      "SETTINGS": false,
      "IBLOCK_ID": 149
    },
    "PROPERTY_1197": {
      "FIELD_ID": "PROPERTY_1197",
      "SORT": 20,
      "NAME": "Priority",
      "IS_REQUIRED": "N",
      "MULTIPLE": "N",
      "DEFAULT_VALUE": "0",
      "TYPE": "N",
      "PROPERTY_TYPE": "N",
      "PROPERTY_USER_TYPE": false,
      "CODE": "PRIORITY",
      "ID": "1197",
      "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"
      },
      "IBLOCK_ID": 149
    }
  }
}
```

## Error response example

404 — no list with the specified identifier exists:

```json
{
  "success": false,
  "error": {
    "code": "LIST_NOT_FOUND",
    "message": "List not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `INVALID_IBLOCK_TYPE` | `iblockTypeId` is not one of the allowed types |
| 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

- [Get field](/docs/lists/fields/get)
- [Field types](/docs/lists/fields/field-types)
- [Create a field](/docs/lists/fields/create)
- [List fields](/docs/lists/fields)