Get User Field Settings userfieldconfig.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: userfieldconfig, module scope from moduleId (for example, crm)

Who can execute the method: a user with read access to the object that owns the field in the moduleId

The userfieldconfig.get method returns the settings of a user field by its identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

moduleId*
string

Identifier of the module where the field is located

id*
integer

Identifier of the user field settings.

The identifier can be obtained using the userfieldconfig.list method or when creating a field with the userfieldconfig.add method

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 '{"moduleId":"crm","id":7095}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldconfig.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm","id":7095,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/userfieldconfig.get

try
        {
            const response = await $b24.callMethod(
                'userfieldconfig.get',
                {
                    moduleId: 'crm',
                    id: 7095,
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'userfieldconfig.get',
                    [
                        'moduleId' => 'crm',
                        'id' => 7095,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Result: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'userfieldconfig.get',
            {
                moduleId: 'crm',
                id: 7095,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'userfieldconfig.get',
            [
                'moduleId' => 'crm',
                'id' => 7095,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "field": {
                    "id": "7095",
                    "entityId": "CRM_7",
                    "fieldName": "UF_CRM_7_NEW_REST_LIST_2026",
                    "userTypeId": "enumeration",
                    "xmlId": null,
                    "sort": "100",
                    "multiple": "Y",
                    "mandatory": "N",
                    "showFilter": "N",
                    "showInList": "Y",
                    "editInList": "Y",
                    "isSearchable": "N",
                    "settings": {
                        "DISPLAY": "LIST",
                        "LIST_HEIGHT": 1,
                        "CAPTION_NO_VALUE": "",
                        "SHOW_NO_VALUE": "Y"
                    },
                    "languageId": {
                        "en": "en",
                        "de": "de"
                    },
                    "editFormLabel": {
                        "en": "List of characteristics",
                        "de": "Liste der Merkmale"
                    },
                    "listColumnLabel": {
                        "en": null,
                        "de": null
                    },
                    "listFilterLabel": {
                        "en": null,
                        "de": null
                    },
                    "errorMessage": {
                        "en": null,
                        "de": null
                    },
                    "helpMessage": {
                        "en": null,
                        "de": null
                    },
                    "enum": [
                        {
                            "id": "3671",
                            "userFieldId": "7095",
                            "value": "Characteristic 1",
                            "def": "N",
                            "sort": "100",
                            "xmlId": "38a8c98a5de02f8ccdca2244e5065ecd"
                        },
                        {
                            "id": "3673",
                            "userFieldId": "7095",
                            "value": "Characteristic 2",
                            "def": "Y",
                            "sort": "200",
                            "xmlId": "9520e17b39f3525b820b809914b52207"
                        }
                    ]
                }
            },
            "time": {
                "start": 1774355752,
                "finish": 1774355752.177393,
                "duration": 0.17739295959472656,
                "processing": 0,
                "date_start": "2026-03-24T15:35:52+01:00",
                "date_finish": "2026-03-24T15:35:52+01:00",
                "operating_reset_at": 1774356352,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response. If the field is not found, it may return `null`
time `time`	Information about the execution time of the request

Result Object

Name `type`	Description
field `object`	User field settings (detailed description)

Field Object

Name `type`	Description
id `integer`	Identifier of the field settings
entityId `string`	Identifier of the object
fieldName `string`	Field code
userTypeId `string`	Identifier of the field type
xmlId `string`	External identifier of the field
sort `integer`	Sort index
multiple `boolean`	Flag for multiple values (`Y`/`N`)
mandatory `boolean`	Flag for required field (`Y`/`N`)
showFilter `boolean`	Flag for showing the field in the filter
showInList `boolean`	Flag for showing the field in the list
editInList `boolean`	Flag for editing in the list
isSearchable `boolean`	Flag for participation in search
settings `object`	Additional field settings. The composition of keys depends on `userTypeId`
languageId `object`	Languages for which field labels are defined
editFormLabel `lang_map`	Labels in the edit form
listColumnLabel `lang_map`	Column labels in the list
listFilterLabel `lang_map`	Labels in the filter
errorMessage `lang_map`	Error message text
helpMessage `lang_map`	Field help text
enum `object[]`	Value options. The field is returned only for `userTypeId = enumeration`

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "You do not have permission to view user field settings"
        }

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

Code	Description	Value
`-`	You do not have permission to view user field settings	Insufficient rights to view the field. This same error may be returned if the field with the provided `id` has already been deleted or is unavailable in the context of `moduleId`
`-`	The current method required more scopes. (crm)	The application does not have the required scope for the module from `moduleId`
`-`	No settings for UserFieldAccess	Access to user fields is not configured for the provided `moduleId`

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Delete Custom Field Settings

Get Available Custom Field Types

Get User Field Settings userfieldconfig.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Field ObjectField Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning