Pause the current workday timeman.pause

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.pause pauses the current workday.

If the workday is completed, the method will resume it and add the time that has passed since completion to the duration.

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)

JS (TS)

JS (UMD)

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

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

// 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 TimemanPauseResult = {
          STATUS: string
          TIME_START: ISODate
          TIME_FINISH: ISODate | null
          DURATION: string
          TIME_LEAKS: string
          ACTIVE: boolean
          IP_OPEN: string
          IP_CLOSE: string
          LAT_OPEN: number
          LON_OPEN: number
          LAT_CLOSE: number
          LON_CLOSE: number
          TZ_OFFSET: number
          TIME_FINISH_DEFAULT?: ISODate
        }
        
        try {
          const response = await $b24.actions.v2.call.make<TimemanPauseResult>({
            method: 'timeman.pause',
            params: {
              USER_ID: 503,
            },
            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('Status:', result.STATUS, 'Start:', result.TIME_START)
          }
        } 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 pauseWorkday() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'timeman.pause',
                params: {
                  USER_ID: 503,
                },
                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('Status:', result.STATUS, 'Start:', result.TIME_START)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', pauseWorkday)
        </script>

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

BX24.callMethod(
            'timeman.pause',
            {
                '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.pause',
            [
                'USER_ID' => 503
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "STATUS": "PAUSED",
                "TIME_START": "2025-03-27T08:00:01+02:00",
                "TIME_FINISH": null,
                "DURATION": "00:00:00",
                "TIME_LEAKS": "00:00:00",
                "ACTIVE": false,
                "IP_OPEN": "",
                "IP_CLOSE": "",
                "LAT_OPEN": 53.548841000000003,
                "LON_OPEN": 9.9872739999999993,
                "LAT_CLOSE": 0,
                "LON_CLOSE": 0,
                "TZ_OFFSET": 7200
            },
            "time": {
                "start": 1743057425.9403241,
                "finish": 1743057426.0597129,
                "duration": 0.11938881874084473,
                "processing": 0.08620214462280273,
                "date_start": "2025-03-27T09:37:05+03:00",
                "date_finish": "2025-03-27T09:37:06+03:00",
                "operating_reset_at": 1743058025,
                "operating": 0
            }
        }

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 started. The timezone corresponds to the timezone of the start of the workday
TIME_FINISH `datetime`	Date and time when the workday ended. 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`	Timezone offset of the employee in which the workday started. The end time of the workday is adjusted to the timezone of 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

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

Was the article helpful?

Start a New Workday

End the Current Day

Pause the current workday timeman.pause

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning