Get information about the current user user.current

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

Who can execute the method: any user

The method user.current returns the profile of the user whose token is used in the request: for a saved administrator token, this is the administrator; for a token from the application frame, this is the user who opened the application.

The list of Bitrix24 user fields that will be received as a result of the method execution depends on the application/webhook scope. The fields available in each version are listed in the User Scope Versions article.

Method Parameters

No parameters.

To find out which user opened the application in the Bitrix24 frame, call the method with the AUTH_ID token from the request to the application on the DOMAIN domain.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

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.current

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

// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type UserCurrentResult = {
          ID: string
          ACTIVE: boolean
          NAME: string
          LAST_NAME: string
          EMAIL: string
          LAST_LOGIN: ISODate | ''
          DATE_REGISTER: ISODate | ''
          IS_ONLINE: string
          LAST_ACTIVITY_DATE?: string
          PERSONAL_GENDER: string
          PERSONAL_BIRTHDAY: string
          WORK_POSITION: string
          UF_EMPLOYMENT_DATE: string
          UF_DEPARTMENT: number[]
        }
        
        try {
          const response = await $b24.actions.v2.call.make<UserCurrentResult>({
            method: 'user.current',
            params: {},
            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('Current user:', result.ID, result.NAME, result.LAST_NAME)
          }
        } 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 getCurrentUser() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'user.current',
                params: {},
                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('Current user:', result.ID, result.NAME, result.LAST_NAME)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getCurrentUser)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.user.current().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(
                    'user.current',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

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

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

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "user.current", nil)
        if err != nil {
        	return fmt.Errorf("user.current: %w", err)
        }
        
        var item struct {
        	ID        b24.ID `json:"ID"`
        	Active    bool   `json:"ACTIVE"`
        	Name      string `json:"NAME"`
        	LastName  string `json:"LAST_NAME"`
        	Email     string `json:"EMAIL"`
        	LastLogin string `json:"LAST_LOGIN"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Active)

Response Handling

HTTP status: 200

{
            "result": {
                "ID": "1",
                "XML_ID": "10001",
                "ACTIVE": true,
                "NAME": "Klaus",
                "LAST_NAME": "Weber",
                "EMAIL": "weber@example.com",
                "LAST_LOGIN": "2026-10-29T15:13:52+01:00",
                "DATE_REGISTER": "2025-10-02T03:00:00+02:00",
                "TIME_ZONE": "Europe/Berlin",
                "IS_ONLINE": "Y",
                "TIMESTAMP_X": "10/27/2026 12:12:19 pm",
                "LAST_ACTIVITY_DATE": "2026-10-29 17:58:08",
                "PERSONAL_GENDER": "M",
                "PERSONAL_BIRTHDAY": "",
                "PERSONAL_PHOTO": "https://cdn-com.bitrix24.com/b1/main/a1b/a1b2c3/avatar.png",
                "PERSONAL_MOBILE": "+4915100000000",
                "WORK_POSITION": "Sales Manager",
                "UF_EMPLOYMENT_DATE": "",
                "UF_DEPARTMENT": [
                    1
                ],
                "UF_USR_USER_DEALS": false
            },
            "time": {
                "start": 1793286068,
                "finish": 1793286068.341957,
                "duration": 0.34195709228515625,
                "processing": 0,
                "date_start": "2026-10-29T18:01:08+01:00",
                "date_finish": "2026-10-29T18:01:08+01:00",
                "operating_reset_at": 1793286660,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	User profile (detailed description)
time `time`	Information about the request execution time

User Fields

The method returns only the fields allowed by the scope version. The list for each version is in the User Scope Versions article. A field with a null value is omitted from the response; empty strings are returned.

Name `type`	Description
ID `string`	User ID. A number as a string
XML_ID `string`	External user code
ACTIVE `boolean`	Whether the user is active: `true` — active `false` — dismissed
NAME `string`	First name
LAST_NAME `string`	Last name
SECOND_NAME `string`	Middle name
TITLE `string`	Salutation
EMAIL `string`	E-mail
LAST_LOGIN `string`	Date and time of the last login in ISO 8601 format, for example `2026-10-29T15:13:52+01:00`
DATE_REGISTER `string`	Registration date in ISO 8601 format
TIME_ZONE `string`	User time zone, for example `Europe/Berlin`
IS_ONLINE `string`	Whether the user is online: `Y` — online `N` — not online
TIMESTAMP_X `string`	Date and time of the last profile change in the site format, for example `10/27/2026 12:12:19 pm`
LAST_ACTIVITY_DATE `string`	Date and time of the last activity in the `YYYY-MM-DD HH:MM:SS` format
PERSONAL_GENDER `string`	Gender: `M` — male `F` — female empty string — not specified
PERSONAL_PROFESSION `string`	Profession
PERSONAL_WWW `string`	Personal website
PERSONAL_BIRTHDAY `string`	Date of birth in ISO 8601 format. An empty string if not specified
PERSONAL_PHOTO `string`	Profile photo link
PERSONAL_ICQ `string`	ICQ
PERSONAL_PHONE `string`	Personal phone
PERSONAL_FAX `string`	Personal fax
PERSONAL_MOBILE `string`	Personal mobile
PERSONAL_PAGER `string`	Pager
PERSONAL_STREET `string`	Residential street
PERSONAL_CITY `string`	Residential city
PERSONAL_STATE `string`	Residential region or territory
PERSONAL_ZIP `string`	Residential postal code
PERSONAL_COUNTRY `string`	Residential country code. `0` if the country is not specified
PERSONAL_MAILBOX `string`	P.O. Box
PERSONAL_NOTES `string`	Additional notes
WORK_PHONE `string`	Company phone
WORK_COMPANY `string`	Company
WORK_POSITION `string`	Job title
WORK_DEPARTMENT `string`	Department, a text field. Departments from the company structure are stored in `UF_DEPARTMENT`
WORK_WWW `string`	Company website
WORK_FAX `string`	Work fax
WORK_PAGER `string`	Work pager
WORK_STREET `string`	Street of the company address
WORK_MAILBOX `string`	Company P.O. box
WORK_CITY `string`	Work city
WORK_STATE `string`	State or region of the company address
WORK_ZIP `string`	Company postal code
WORK_COUNTRY `string`	Country code of the company address. `0` if the country is not specified
WORK_PROFILE `string`	Company's areas of business
WORK_LOGO `string`	Company logo
WORK_NOTES `string`	Notes about the workplace
UF_SKYPE_LINK `string`	Skype chat link
UF_ZOOM `string`	Zoom
UF_EMPLOYMENT_DATE `string`	Hiring date in ISO 8601 format. An empty string if not specified
UF_TIMEMAN `string`	Whether time tracking is enabled for the user: `1` — enabled, any other value — disabled
UF_DEPARTMENT `integer[]`	IDs of departments from the company structure. Retrieve departments using department.get
UF_INTERESTS `string`	Interests
UF_SKILLS `string`	Skills
UF_WEB_SITES `string`	Other websites
UF_XING `string`	Xing
UF_LINKEDIN `string`	LinkedIn
UF_FACEBOOK `string`	Facebook
UF_TWITTER `string`	Twitter
UF_SKYPE `string`	Microsoft Teams. The field code is kept from Skype
UF_DISTRICT `string`	District
UF_PHONE_INNER `string`	Extension number
USER_TYPE `string`	User type. Main values: `employee` — employee `extranet` — external extranet user `email` — user who writes from email `bot` — chatbot
UF_USR_* `various`	Custom profile fields. The value type depends on the field type: a string, a number, an array, or, for a file, an object with the `id`, `showUrl`, and `downloadData` keys. Fields are created by the user.userfield.* methods

The USER_TYPE field is returned by the user.get and user.search methods. The user.current method does not return this field.

Error Handling

HTTP status: 401

{
            "error": "INVALID_CREDENTIALS",
            "error_description": "Invalid request credentials"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

The method has no parameters, so it has no errors of its own. The method returns only system errors, for example:

Status	Code	Description	Value
`401`	`INVALID_CREDENTIALS`	Invalid request credentials	Invalid webhook code or authorization token
`401`	`insufficient_scope`	The request requires higher privileges than provided by the webhook token	The webhook or application has none of the scope versions: `user`, `user_basic`, or `user_brief`

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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	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
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	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 — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not 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
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	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 `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	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

Was the article helpful?

Update User Data

Get User List by Filter

Get information about the current user user.current

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

User FieldsUser Fields

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning