Get Description for Custom Fields crm.userfield.fields

Scope: crm

Who can execute the method: any user

The method crm.userfield.fields returns a description of the characteristics of custom 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" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.userfield.fields

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

try
        {
        	const response = await $b24.callMethod(
        		"crm.userfield.fields",
        		{}
        	);
        
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch(error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.userfield.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching CRM userfield fields: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.userfield.fields",
            {},
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.userfield.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "ID": {
                    "type": "int",
                    "title": "ID",
                    "isReadOnly": true
                },
                "ENTITY_ID": {
                    "type": "string",
                    "title": "Object",
                    "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": "Sorting"
                },
                "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": "Label in edit form"
                },
                "LIST_COLUMN_LABEL": {
                    "type": "string",
                    "title": "Header in list"
                },
                "LIST_FILTER_LABEL": {
                    "type": "string",
                    "title": "Filter label in list"
                },
                "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)"
                }
            },
            "time": {
                "start": 1773992295,
                "finish": 1773992295.958088,
                "duration": 0.9580879211425781,
                "processing": 0,
                "date_start": "2026-03-20T10:38:15+02:00",
                "date_finish": "2026-03-20T10:38:15+02:00",
                "operating_reset_at": 1773992895,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with a description of characteristics (detailed description)
time `time`	Information about the request execution time

Fields of the result object

Name `type`	Description
ID `integer`	Identifier
ENTITY_ID `string`	Custom field object
FIELD_NAME `string`	Field code
USER_TYPE_ID `string`	Custom field data type
XML_ID `string`	External ID (XML ID)
SORT `integer`	Sorting order
MULTIPLE `char`	Multiple indicator
MANDATORY `char`	Mandatory indicator
SHOW_FILTER `char`	Display in list filter indicator
SHOW_IN_LIST `char`	Display in list indicator
EDIT_IN_LIST `char`	Allow user editing indicator
IS_SEARCHABLE `char`	Field values are searchable indicator
EDIT_FORM_LABEL `string`\|`lang_map`	Label in edit form
LIST_COLUMN_LABEL `string`\|`lang_map`	Header in list
LIST_FILTER_LABEL `string`\|`lang_map`	Filter label in list
ERROR_MESSAGE `string`\|`lang_map`	Error message
HELP_MESSAGE `string`\|`lang_map`	Help
LIST `uf_enum_element`	List elements for `enumeration` type field
SETTINGS `object`	Additional settings depending on field type

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

Custom Field Types in CRM

Get List of Custom Field Types

Get Description for Custom Fields crm.userfield.fields

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Fields of the result objectFields of the result object

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning