Get User Fields user.fields

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: user, user_brief, user_basic

Who can execute the method: any user

The user.fields method allows you to retrieve a list of user field names. The method returns a standard list of fields, and the use of custom fields is not supported.

The list of user fields in Bitrix24 that will be obtained as a result of executing the method depends on the application's/webhook's scope. Details about accessing user data can be found in the article.

Without 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**/user.fields

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

try
        {
        	const response = await $b24.callMethod(
        		"user.fields",
        		{}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }

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

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

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

Response Handling

HTTP Status: 200

    {
                "result": {
                    "ID": "ID",
                    "XML_ID": "External code",
                    "ACTIVE": "Activity",
                    "NAME": "First Name",
                    "LAST_NAME": "Last Name",
                    "SECOND_NAME": "Middle Name",
                    "TITLE": "User List",
                    "EMAIL": "E-Mail",
                    "LAST_LOGIN": "Last Login",
                    "DATE_REGISTER": "Registration Date",
                    "TIME_ZONE": "TIME_ZONE",
                    "IS_ONLINE": "IS_ONLINE",
                    "TIMESTAMP_X": "TIMESTAMP_X",
                    "LAST_ACTIVITY_DATE": "LAST_ACTIVITY_DATE",
                    "PERSONAL_GENDER": "Gender",
                    "PERSONAL_PROFESSION": "Profession",
                    "PERSONAL_WWW": "Homepage",
                    "PERSONAL_BIRTHDAY": "Birthday",
                    "PERSONAL_PHOTO": "Photo",
                    "PERSONAL_ICQ": "ICQ",
                    "PERSONAL_PHONE": "Personal Phone",
                    "PERSONAL_FAX": "Fax",
                    "PERSONAL_MOBILE": "Personal Mobile",
                    "PERSONAL_PAGER": "Pager",
                    "PERSONAL_STREET": "Street Address",
                    "PERSONAL_CITY": "City of Residence",
                    "PERSONAL_STATE": "Region / Territory",
                    "PERSONAL_ZIP": "Postal Code",
                    "PERSONAL_COUNTRY": "Country",
                    "PERSONAL_MAILBOX": "Mailbox",
                    "PERSONAL_NOTES": "Additional Notes",
                    "WORK_PHONE": "Company Phone",
                    "WORK_COMPANY": "Company",
                    "WORK_POSITION": "Position",
                    "WORK_DEPARTMENT": "Department",
                    "WORK_WWW": "Company Website",
                    "WORK_FAX": "WORK_FAX",
                    "WORK_PAGER": "WORK_PAGER",
                    "WORK_STREET": "WORK_STREET",
                    "WORK_MAILBOX": "WORK_MAILBOX",
                    "WORK_CITY": "City of Work",
                    "WORK_STATE": "WORK_STATE",
                    "WORK_ZIP": "WORK_ZIP",
                    "WORK_COUNTRY": "WORK_COUNTRY",
                    "WORK_PROFILE": "WORK_PROFILE",
                    "WORK_LOGO": "WORK_LOGO",
                    "WORK_NOTES": "WORK_NOTES",
                    "UF_SKYPE_LINK": "Skype Chat Link",
                    "UF_ZOOM": "Zoom",
                    "UF_EMPLOYMENT_DATE": "Employment Date",
                    "UF_TIMEMAN": "Time Management",
                    "UF_DEPARTMENT": "Departments",
                    "UF_INTERESTS": "Interests",
                    "UF_SKILLS": "Skills",
                    "UF_WEB_SITES": "Other Websites",
                    "UF_XING": "Xing",
                    "UF_LINKEDIN": "LinkedIn",
                    "UF_FACEBOOK": "Facebook",
                    "UF_TWITTER": "Twitter",
                    "UF_SKYPE": "Skype",
                    "UF_DISTRICT": "District",
                    "UF_PHONE_INNER": "Internal Phone",
                    "USER_TYPE": "USER_TYPE"
                },
                "time": {
                    "start": 1721719975.764591,
                    "finish": 1721719975.786585,
                    "duration": 0.02199411392211914,
                    "processing": 0.0005099773406982422,
                    "date_start": "2024-07-23T07:32:55+00:00",
                    "date_finish": "2024-07-23T07:32:55+00:00",
                    "operating": 0
                }
            }

Returned Data

Name `type`	Description
result `object`	Root element of the response containing user fields
time `time`	Information about the request execution time

Error Handling

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

Get User List with Personal Data Search

Overview of Methods

Get User Fields user.fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning