Pause the current workday timeman.pause
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:
timemanWho 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 |
Description |
|
USER_ID |
User identifier. By default — the identifier of the current user |
Code Examples
How to Use Examples in Documentation
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.timeman.pause(user_id=503).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(
'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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "timeman.pause", b24.Params{
"USER_ID": 503,
})
if err != nil {
return fmt.Errorf("timeman.pause: %w", err)
}
var item struct {
Status string `json:"STATUS"`
TimeStart string `json:"TIME_START"`
Duration string `json:"DURATION"`
TimeLeaks string `json:"TIME_LEAKS"`
Active bool `json:"ACTIVE"`
IPOpen string `json:"IP_OPEN"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Status, item.TimeStart)
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 |
Description |
|
result |
Root element of the response. Contains an object describing the workday |
|
STATUS |
Status of the current workday. Possible values:
|
|
TIME_START |
Date and time when the workday started. The timezone corresponds to the timezone of the start of the workday |
|
TIME_FINISH |
Date and time the workday ended. Returns |
|
DURATION |
Duration of the workday in the format Returns |
|
TIME_LEAKS |
Total duration of breaks during the day in the format |
|
ACTIVE |
Confirmation of the workday. A value of |
|
IP_OPEN |
IP address from which the workday started |
|
IP_CLOSE |
IP address from which the workday ended. Returns |
|
LAT_OPEN |
Geographical latitude of the point where the workday started |
|
LON_OPEN |
Geographical longitude of the point where the workday started |
|
LAT_CLOSE |
Geographical latitude of the point where the workday ended |
|
LON_CLOSE |
Geographical longitude of the point where the workday ended |
|
TZ_OFFSET |
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 |
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 |
|
time |
Information about the time taken to process the request |
Error Handling
HTTP status: 400
{
"error":"",
"error_description":"User not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
empty string |
User not found |
User with the specified |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |