Get User Field of Task by ID task.item.userfield.get

Scope: task

Who can execute the method: any user

The method task.item.userfield.get retrieves the description of a user field of a task by its ID.

Method Parameters

Required parameters are marked with *

Name
type

Description

ID*
integer

Identifier of the user field.

The identifier of the task's user field can be obtained when creating the field or by using the method to get the list of fields

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ID": 1325
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ID": 1325,
          "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/task.item.userfield.get

try
        {
            const response = await $b24.callMethod(
                'task.item.userfield.get',
                {
                    ID: 1325
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'task.item.userfield.get',
                    [
                        'ID' => 1325
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'task.item.userfield.get',
            {
                ID: 1325
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'task.item.userfield.get',
            [
                'ID' => 1325
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "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": "Clarify the goal and expected outcome"
                },
                "EDIT_FORM_LABEL": {
                    "ar": "",
                    "br": "",
                    "de": "",
                    "en": "Description of client request",
                    ...
                },
                "LIST_COLUMN_LABEL": {
                    "en": "Сlient request",
                    ...
                },
                "LIST_FILTER_LABEL": {
                    "en": "Сlient request",
                    ...
                },
                "ERROR_MESSAGE": {
                    "en": "Сlient request",
                    ...
                },
                "HELP_MESSAGE": {
                    "en": "Сlient request",
                    ...
                }
            },
            "total": 0,
            "time": {
                "start": 1772718119,
                "finish": 1772718119.677154,
                "duration": 0.6771540641784668,
                "processing": 0,
                "date_start": "2026-03-05T16:41:59+01:00",
                "date_finish": "2026-03-05T16:41:59+01:00",
                "operating_reset_at": 1772718719,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	User field object (detailed description)
total `integer`	Currently returns `0`
time `time`	Information about the execution time of the request

Result Object

Name `type`	Description
ID `integer`	Identifier of the user field
ENTITY_ID `string`	Code of the object to which the field is linked
FIELD_NAME `string`	Code of the user field
USER_TYPE_ID `string`	Data type
XML_ID `string`	External identifier
SORT `integer`	Sort order
MULTIPLE `char`	Indicates multiple values. Possible values: `Y` — multiple `N` — single
MANDATORY `char`	Indicates required field. Possible values: `Y` — required `N` — not required
SHOW_FILTER `char`	Display in the list filter
SHOW_IN_LIST `char`	Display in the list
EDIT_IN_LIST `char`	Editing allowed in the list
IS_SEARCHABLE `char`	Value is searchable
EDIT_FORM_LABEL `object`	Localized labels in the edit form
LIST_COLUMN_LABEL `object`	Localized column headers in the list
LIST_FILTER_LABEL `object`	Localized labels in the list filter
ERROR_MESSAGE `object`	Localized validation error texts
HELP_MESSAGE `object`	Localized hints for the field
SETTINGS `object`	Additional field settings (detailed description)

SETTINGS Object

Name `type`	Description
SIZE `integer`	Input field width
ROWS `integer`	Number of rows in the input field
REGEXP `string`	Regular expression for value validation
MIN_LENGTH `integer`	Minimum length of the value
MAX_LENGTH `integer`	Maximum length of the value
DEFAULT_VALUE `string`	Default value

Error Handling

HTTP Status: 400

{
            "error": "ERROR_CORE",
            "error_description": "ID is not defined or invalid."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`400`	`ERROR_CORE`	No parameters found	Required parameter `ID` not provided
`400`	`ERROR_CORE`	ID is not defined or invalid	Non-numeric value or value `<= 0` provided for parameter `ID`
`400`	`ERROR_NOT_FOUND`	The entity with ID '{ID}' is not found	User field with the specified `ID` not found

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Update Custom Field

Get List of Custom Fields

Get User Field of Task by ID task.item.userfield.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

SETTINGS ObjectSETTINGS Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning