# task.item.userfield.getlist

URL: https://chugunov.pro/api-bitrix24/tasks/user-field/task-item-user-field-get-list/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить список пользовательских полей
Scope: `task`
Кто может выполнять метод: любой пользователь

## Описание

Метод `task.item.userfield.getlist` получает список пользовательских полей задач.

В списке будет три системных поля задач для связи с другими объектами:

- `UF_CRM_TASK` — с объектами CRM
- `UF_MAIL_MESSAGE` — с письмом Почты
- `UF_TASK_WEBDAV_FILES` — c файлами Диска

Они созданы на основе пользовательских полей, поэтому есть в списке. Подробнее о связях задачи с другими объектами — в статье [Задачи: обзор методов](https://chugunov.pro/api-bitrix24/tasks/).

## Параметры

- `ORDER` `object` — необязательный. Объект для сортировки результата вида `{"поле": "значение сортировки", ... }`.
  Сортировать можно по полям:
  - `ID` — идентификатор пользовательского поля
  - `FIELD_NAME` — код пользовательского поля
  - `USER_TYPE_ID` — тип пользовательского поля
  - `SORT` — значение сортировки
  Направление сортировки может принимать значения:
  - `asc` — по возрастанию
  - `desc` — по убыванию
- `FILTER` `object` — необязательный. Объект для фильтрации результата вида `{"поле": "значение фильтра", ... }`. Значением фильтруемого поля может быть одиночное значение или массив значений.
  Фильтровать можно по полям:
  - `ID` — идентификатор пользовательского поля
  - `FIELD_NAME` — код пользовательского поля
  - `USER_TYPE_ID` — тип пользовательского поля
  - `XML_ID` — внешний идентификатор
  - `MULTIPLE` — множественное, `Y`или `N`
  - `MANDATORY` — обязательное, `Y` или `N`

## Ответ

HTTP-статус: 200

```json
{
    "result": [
        {
            "ID": "1295",
            "ENTITY_ID": "TASKS_TASK",
            "FIELD_NAME": "UF_CRM_TASK",
            "USER_TYPE_ID": "crm",
            "XML_ID": "",
            "SORT": "100",
            "MULTIPLE": "Y",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "N",
            "EDIT_IN_LIST": "N",
            "IS_SEARCHABLE": "N",
            "SETTINGS": {
                "LEAD": "Y",
                "CONTACT": "Y",
                "COMPANY": "Y",
                "DEAL": "Y"
            }
        },
        {
            "ID": "662",
            "ENTITY_ID": "TASKS_TASK",
            "FIELD_NAME": "UF_MAIL_MESSAGE",
            "USER_TYPE_ID": "mail_message",
            "XML_ID": "",
            "SORT": "100",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "N",
            "EDIT_IN_LIST": "N",
            "IS_SEARCHABLE": "N",
            "SETTINGS": []
        },
        {
            "ID": "229",
            "ENTITY_ID": "TASKS_TASK",
            "FIELD_NAME": "UF_TASK_WEBDAV_FILES",
            "USER_TYPE_ID": "disk_file",
            "XML_ID": "TASK_WEBDAV_FILES",
            "SORT": "100",
            "MULTIPLE": "Y",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "Y",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "Y",
            "SETTINGS": {
                "IBLOCK_ID": 0,
                "SECTION_ID": 0,
                "UF_TO_SAVE_ALLOW_EDIT": ""
            }
        },
        {
            "ID": "1325",
            "ENTITY_ID": "TASKS_TASK",
            "FIELD_NAME": "UF_TASK_CLIENT_REQUEST",
            "USER_TYPE_ID": "string",
            "XML_ID": "UF_TASK_CLIENT_REQUEST",
            "SORT": "220",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "Y",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "N",
            "SETTINGS": {
                "SIZE": 20,
                "ROWS": 10,
                "REGEXP": "",
                "MIN_LENGTH": 0,
                "MAX_LENGTH": 0,
                "DEFAULT_VALUE": "Уточнить цель и ожидаемый результат"
            }
        },
        {
            "ID": "1333",
            "ENTITY_ID": "TASKS_TASK",
            "FIELD_NAME": "UF_TASK_PROJECT_BUDGET",
            "USER_TYPE_ID": "double",
            "XML_ID": "UF_TASK_PROJECT_BUDGET",
            "SORT": "230",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "Y",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "N",
            "SETTINGS": {
                "PRECISION": 0,
                "SIZE": 20,
                "MIN_VALUE": 0,
                "MAX_VALUE": 0,
                "DEFAULT_VALUE": 0
            }
        },
        {
            "ID": "1335",
            "ENTITY_ID": "TASKS_TASK",
            "FIELD_NAME": "UF_TASK_APPROVAL_DEADLINE",
            "USER_TYPE_ID": "datetime",
            "XML_ID": "UF_TASK_APPROVAL_DEADLINE",
            "SORT": "240",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "Y",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "N",
            "SETTINGS": {
                "DEFAULT_VALUE": {
                    "TYPE": "NONE",
                    "VALUE": ""
                },
                "USE_SECOND": "Y",
                "USE_TIMEZONE": "N"
            }
        },
        {
            "ID": "1337",
            "ENTITY_ID": "TASKS_TASK",
            "FIELD_NAME": "UF_TASK_LEGAL_REVIEW_REQUIRED",
            "USER_TYPE_ID": "boolean",
            "XML_ID": "UF_TASK_LEGAL_REVIEW_REQUIRED",
            "SORT": "250",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "Y",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "N",
            "SETTINGS": {
                "DEFAULT_VALUE": 0,
                "DISPLAY": "CHECKBOX",
                "LABEL": ["", ""],
                "LABEL_CHECKBOX": ""
            }
        }
    ],
    "total": 0,
    "time": {
        "start": 1772718556,
        "finish": 1772718556.080225,
        "duration": 0.08022499084472656,
        "processing": 0,
        "date_start": "2026-03-05T16:49:16+03:00",
        "date_finish": "2026-03-05T16:49:16+03:00",
        "operating_reset_at": 1772719156,
        "operating": 0
    }
}
```

### Возвращаемые данные

- `result` `array`. Массив объектов пользовательских полей [(подробное описание)](#result)
- `total` `integer`. Сейчас возвращает `0`
- `time` `time`. Информация о времени выполнения запроса

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "ORDER": {
    "SORT": "ASC"
  }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.getlist
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "ORDER": {
    "SORT": "ASC"
  },
  "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/task.item.userfield.getlist
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type UserFieldItem = {
  ID: string
  ENTITY_ID: string
  FIELD_NAME: string
  USER_TYPE_ID: string
  XML_ID: string
  SORT: string
  MULTIPLE: string
  MANDATORY: string
  SHOW_FILTER: string
  SHOW_IN_LIST: string
  EDIT_IN_LIST: string
  IS_SEARCHABLE: string
  SETTINGS: Record<string, unknown>
}

try {
  // task.item.userfield.getlist returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<UserFieldItem[]>({
    method: 'task.item.userfield.getlist',
    params: {
      ORDER: {
        SORT: 'ASC',
      },
      start: 0,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('User fields count:', result.length, result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getUserFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // task.item.userfield.getlist returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'task.item.userfield.getlist',
        params: {
          ORDER: {
            SORT: 'ASC',
          },
          start: 0,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('User fields count:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getUserFields)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

order = {
    "SORT": "ASC",
}

try:
    bitrix_response = client.task.item.userfield.getlist(
        order=order,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'task.item.userfield.getlist',
            [
                'ORDER' => [
                    'SORT' => 'ASC'
                ]
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'task.item.userfield.getlist',
    {
        ORDER: {
            SORT: 'ASC'
        },
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'task.item.userfield.getlist',
    [
        'ORDER' => [
            'SORT' => 'ASC'
        ]
    ]
);

print_r($result);
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "task.item.userfield.getlist", b24.Params{
	"ORDER": b24.Params{
		"SORT": "ASC",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("task.item.userfield.getlist: %w", err)
}

var items []struct {
	ID         b24.ID `json:"ID"`
	EntityID   string `json:"ENTITY_ID"`
	FieldName  string `json:"FIELD_NAME"`
	UserTypeID string `json:"USER_TYPE_ID"`
	XMLID      string `json:"XML_ID"`
	Sort       string `json:"SORT"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.EntityID)
}
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/tasks/user-field/task-item-user-field-get-list.html