Get information about the current workday timeman.status

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: timeman

Who can execute the method: any user

The method timeman.status retrieves information about the current workday.

Method parameters

Name
type

Description

USER_ID
integer

User identifier.

By default — the identifier of the current user

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 '{"USER_ID":503}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.status

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"USER_ID":503,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/timeman.status

try
        {
        	const response = await $b24.callMethod(
        		'timeman.status',
        		{
        			'USER_ID' : 503
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'timeman.status',
                    [
                        'USER_ID' => 503
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Info: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling timeman.status: ' . $e->getMessage();
        }

BX24.callMethod(
            'timeman.status',
            {
                'USER_ID' : 503
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'timeman.status',
            [
                'USER_ID' => 503
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response handling

HTTP status: 200

{
            "result": {
                "STATUS": "EXPIRED",
                "TIME_START": "2025-03-27T08:00:01+02:00",
                "TIME_FINISH": null,
                "DURATION": "00:00:00",
                "TIME_LEAKS": "00:17:53",
                "ACTIVE": false,
                "IP_OPEN": "",
                "IP_CLOSE": "",
                "LAT_OPEN": 53.548841000000003,
                "LON_OPEN": 9.9872739999999993,
                "LAT_CLOSE": 0,
                "LON_CLOSE": 0,
                "TZ_OFFSET": 7200,
                "TIME_FINISH_DEFAULT": "2025-03-27T17:00:00+02:00"
            },
            "time": {
                "start": 1743057653.725821,
                "finish": 1743057654.0894129,
                "duration": 0.36359190940856934,
                "processing": 0.3278491497039795,
                "date_start": "2025-03-27T09:40:53+03:00",
                "date_finish": "2025-03-27T09:40:54+03:00",
                "operating_reset_at": 1743058253,
                "operating": 0.32782983779907227
            }
        }

Returned data

Name `type`	Description
result `object`	Root element of the response. Contains an object with the description of the workday
STATUS `string`	Status of the current workday. Possible values: `OPENED` — opened `CLOSED` — closed `PAUSED` — paused `EXPIRED` — expired, meaning opened before the start of the current calendar day and not closed
TIME_START `datetime`	Date and time when the workday starts. The time zone corresponds to the time zone at the start of the workday
TIME_FINISH `datetime`	Date and time when the workday ends. Returns `null` for an unfinished workday
DURATION `string`	Duration of the workday in the format `HH:MM:SS`. Returns `00:00:00` for an unfinished workday
TIME_LEAKS `string`	Total duration of breaks during the day in the format `HH:MM:SS`
ACTIVE `boolean`	Confirmation of the workday. A value of `false` means that the change to the workday is awaiting confirmation from the supervisor
IP_OPEN `string`	IP address from which the workday started
IP_CLOSE `string`	IP address from which the workday ended. Returns `null` for an unfinished workday
LAT_OPEN `double`	Geographical latitude of the point where the workday started
LON_OPEN `double`	Geographical longitude of the point where the workday started
LAT_CLOSE `double`	Geographical latitude of the point where the workday ended
LON_CLOSE `double`	Geographical longitude of the point where the workday ended
TZ_OFFSET `integer`	Time zone offset of the employee where the workday started. The end time of the workday is adjusted to the time zone at the start of the day
TIME_FINISH_DEFAULT `datetime`	Recommended value for the end of the day, which can be displayed to the user as a default value. Displayed only for workdays with the status expired `EXPIRED`
time `time`	Information about the time taken to process the request

Error handling

HTTP status: 400

{
            "error":"",
            "error_description":"User not found"
        }

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
empty string	User not found	User with the specified `USER_ID` not found

Continue exploring

End the Current Day

Get Work Time Settings

Get information about the current workday timeman.status

Method parametersMethod parameters

Code examplesCode examples

Response handlingResponse handling

Returned dataReturned data

Error handlingError handling

Possible error codesPossible error codes

Continue exploringContinue exploring