Get Custom Task Field by ID task.item.userfield.get
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.task.item.userfield.get(
bitrix_id=1325,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "task.item.userfield.get", b24.Params{
"ID": 1325,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("task.item.userfield.get: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
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: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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