Get Custom Task Field by ID task.item.userfield.get
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: any user
The method task.item.userfield.get retrieves the description of a custom task field by its ID.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ID* |
Identifier of the custom field. The identifier of the task's custom 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 -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
// 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
// Shape of the user field object returned in result
// Shape of the payload returned in result (match the "response handling" section of the page)
type UserFieldResult = {
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
EDIT_FORM_LABEL: Record<string, string>
LIST_COLUMN_LABEL: Record<string, string>
LIST_FILTER_LABEL: Record<string, string>
ERROR_MESSAGE: Record<string, string>
HELP_MESSAGE: Record<string, string>
SETTINGS: {
SIZE: number
ROWS: number
REGEXP: string
MIN_LENGTH: number
MAX_LENGTH: number
DEFAULT_VALUE: string
}
}
try {
const response = await $b24.actions.v2.call.make<UserFieldResult>({
method: 'task.item.userfield.get',
params: {
ID: 1325,
},
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(result.ID, result.FIELD_NAME, result.USER_TYPE_ID)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 getUserField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.item.userfield.get',
params: {
ID: 1325,
},
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(result.ID, result.FIELD_NAME, result.USER_TYPE_ID)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getUserField)
</script>
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 result"
},
"EDIT_FORM_LABEL": {
"ar": "",
"br": "",
"de": "",
"en": "Description of client request",
...
},
"LIST_COLUMN_LABEL": {
"en": "Client request",
...
},
"LIST_FILTER_LABEL": {
"en": "Client request",
...
},
"ERROR_MESSAGE": {
"en": "Client request",
...
},
"HELP_MESSAGE": {
"en": "Client 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 |
Description |
|
result |
Object of the custom field (detailed description) |
|
total |
Currently returns |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
ID |
Identifier of the custom field |
|
ENTITY_ID |
Code of the object to which the field is attached |
|
FIELD_NAME |
Code of the custom field |
|
USER_TYPE_ID |
Data type |
|
XML_ID |
External identifier |
|
SORT |
Sorting order |
|
MULTIPLE |
Indicator of multiple values. Possible values:
|
|
MANDATORY |
Indicator of a required field. Possible values:
|
|
SHOW_FILTER |
Display in the list filter |
|
SHOW_IN_LIST |
Display in the list |
|
EDIT_IN_LIST |
Editing allowed in the list |
|
IS_SEARCHABLE |
Value is searchable |
|
EDIT_FORM_LABEL |
Localized labels in the edit form |
|
LIST_COLUMN_LABEL |
Localized column headers in the list |
|
LIST_FILTER_LABEL |
Localized labels in the list filter |
|
ERROR_MESSAGE |
Localized validation error texts |
|
HELP_MESSAGE |
Localized hints for the field |
|
SETTINGS |
Additional field settings (detailed description) |
Object SETTINGS
|
Name |
Description |
|
SIZE |
Width of the input field |
|
ROWS |
Number of rows in the input field |
|
REGEXP |
Regular expression for value validation |
|
MIN_LENGTH |
Minimum length of the value |
|
MAX_LENGTH |
Maximum length of the value |
|
DEFAULT_VALUE |
Default value |
Error Handling
HTTP Status: 400
{
"error": "ERROR_CORE",
"error_description": "ID is not defined or invalid."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
|
No parameters found |
Required parameter |
|
|
|
ID is not defined or invalid |
Non-numeric value or value |
|
|
|
The entity with ID '{ID}' is not found |
Custom field with the specified |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Custom Fields in Tasks: Overview of Methods
- Add Custom Field task.item.userfield.add
- Update User Field task.item.userfield.update
- Get a List of Custom Fields task.item.userfield.getlist
- Delete User Field task.item.userfield.delete
- Get a List of Available Data Types for task.item.userfield.gettypes
- Get User Field Fields with task.item.userfield.getfields