Get Custom Field Data with task.item.userfield.getfields

Scope: task

Who can execute the method: any user

The method task.item.userfield.getfields retrieves a list of fields for custom task fields.

Method Parameters

No parameters.

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" \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.getfields

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

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

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

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

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

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": {
                    "type": "int",
                    "title": "ID",
                    "isReadOnly": true
                },
                "ENTITY_ID": {
                    "type": "string",
                    "title": "Entity",
                    "isImmutable": true
                },
                "FIELD_NAME": {
                    "type": "string",
                    "title": "Code",
                    "isImmutable": true
                },
                "USER_TYPE_ID": {
                    "type": "string",
                    "title": "Data Type",
                    "isImmutable": true
                },
                "XML_ID": {
                    "type": "string",
                    "title": "External ID (XML ID)"
                },
                "SORT": {
                    "type": "int",
                    "title": "Sort Order"
                },
                "MULTIPLE": {
                    "type": "char",
                    "title": "Multiple"
                },
                "MANDATORY": {
                    "type": "char",
                    "title": "Mandatory"
                },
                "SHOW_FILTER": {
                    "type": "char",
                    "title": "Show in List Filter"
                },
                "SHOW_IN_LIST": {
                    "type": "char",
                    "title": "Show in List"
                },
                "EDIT_IN_LIST": {
                    "type": "char",
                    "title": "Allow User Editing"
                },
                "IS_SEARCHABLE": {
                    "type": "char",
                    "title": "Field Values are Searchable"
                },
                "EDIT_FORM_LABEL": {
                    "type": "string",
                    "title": "Edit Form Label"
                },
                "LIST_COLUMN_LABEL": {
                    "type": "string",
                    "title": "List Column Header"
                },
                "LIST_FILTER_LABEL": {
                    "type": "string",
                    "title": "List Filter Label"
                },
                "ERROR_MESSAGE": {
                    "type": "string",
                    "title": "Error Message"
                },
                "HELP_MESSAGE": {
                    "type": "string",
                    "title": "Help"
                },
                "LIST": {
                    "type": "uf_enum_element",
                    "title": "List Elements",
                    "isMultiple": true
                },
                "SETTINGS": {
                    "type": "object",
                    "title": "Additional Settings (dependent on type)"
                }
            },
            "total": 0,
            "time": {
                "start": 1772710591,
                "finish": 1772710591.142614,
                "duration": 0.14261388778686523,
                "processing": 0,
                "date_start": "2026-03-05T14:36:31+01:00",
                "date_finish": "2026-03-05T14:36:31+01:00",
                "operating_reset_at": 1772711191,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Description of available custom field properties. Each key of the object contains a field description (detailed description)
total `integer`	Currently returns `0`
time `time`	Information about the request execution time

Object result

Name `type`	Description
ID `integer`	Identifier. Read-only
ENTITY_ID `string`	Entity
FIELD_NAME `string`	Code. Immutable
USER_TYPE_ID `string`	Data Type. Immutable
XML_ID `string`	External Identifier
SORT `integer`	Sort Order
MULTIPLE `char`	Multiple
MANDATORY `char`	Mandatory
SHOW_FILTER `char`	Show in List Filter
SHOW_IN_LIST `char`	Show in List
EDIT_IN_LIST `char`	Allow User Editing
IS_SEARCHABLE `char`	Field Values are Searchable
EDIT_FORM_LABEL `string`	Edit Form Label
LIST_COLUMN_LABEL `string`	List Column Header
LIST_FILTER_LABEL `string`	List Filter Label
ERROR_MESSAGE `string`	Error Message
HELP_MESSAGE `string`	Help
LIST `uf_enum_element`	List Elements. Multiple
SETTINGS `object`	Additional Settings

Field Description Object

Name `type`	Description
type `string`	Field Data Type
title `string`	Field Name
isReadOnly `boolean`	Read-only Field Indicator
isImmutable `boolean`	Immutable Field Indicator
isMultiple `boolean`	Multiple Field Indicator

Error Handling

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

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

Get List of Available Data Types

Overview of Methods

Get Custom Field Data with task.item.userfield.getfields

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Field Description ObjectField Description Object

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning