Get Time Control Settings timeman.timecontrol.settings.get
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: administrator
The method timeman.timecontrol.settings.get retrieves the settings of the time control module.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.timecontrol.settings.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/timeman.timecontrol.settings.get
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type TimecontrolSettingsGetResult = {
active: boolean
minimum_idle_for_report: number
register_offline: boolean
register_idle: boolean
register_desktop: boolean
report_request_type: string
report_request_users: number[]
report_simple_type: string
report_simple_users: number[]
report_full_type: string
report_full_users: number[]
}
try {
const response = await $b24.actions.v2.call.make<TimecontrolSettingsGetResult>({
method: 'timeman.timecontrol.settings.get',
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('active:', result.active, 'report_request_type:', result.report_request_type)
}
} 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 getTimecontrolSettings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'timeman.timecontrol.settings.get',
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('active:', result.active, 'report_request_type:', result.report_request_type)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTimecontrolSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.timeman.timecontrol.settings.get().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.timecontrol.settings.get',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting time control settings: ' . $e->getMessage();
}
BX24.callMethod(
'timeman.timecontrol.settings.get',
{},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'timeman.timecontrol.settings.get',
[]
);
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.timecontrol.settings.get", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("timeman.timecontrol.settings.get: %w", err)
}
var item struct {
Active bool `json:"active"`
MinimumIdleForReport int `json:"minimum_idle_for_report"`
RegisterOffline bool `json:"register_offline"`
RegisterIdle bool `json:"register_idle"`
RegisterDesktop bool `json:"register_desktop"`
ReportRequestType string `json:"report_request_type"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Active, item.MinimumIdleForReport)
Response Handling
HTTP status: 200
{
"result": {
"active": true,
"minimum_idle_for_report": 15,
"register_offline": true,
"register_idle": true,
"register_desktop": true,
"report_request_type": "all",
"report_request_users": [],
"report_simple_type": "all",
"report_simple_users": [],
"report_full_type": "all",
"report_full_users": []
},
"time": {
"start": 1748526089.625516,
"finish": 1748526089.656787,
"duration": 0.03127098083496094,
"processing": 0.008746147155761719,
"date_start": "2025-05-29T16:41:29+02:00",
"date_finish": "2025-05-29T16:41:29+02:00",
"operating_reset_at": 1748526689,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
active |
Activity of the time control module |
|
minimum_idle_for_report |
Minimum idle time in minutes after which a report is required |
|
register_offline |
Register offline status |
|
register_idle |
Register away status |
|
register_desktop |
Register desktop application status |
|
report_request_type |
Type of report requests. Possible values:
|
|
report_request_users |
Array of user IDs for whom report requests are required. Filled if |
|
report_simple_type |
Type of simple report. Possible values:
|
|
report_simple_users |
Array of user IDs with access to the simple report. Filled if |
|
report_full_type |
Type of full report. Possible values:
|
|
report_full_users |
Array of user IDs with access to the full report. Filled if |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "ACCESS_ERROR",
"error_description": "You don't have access to use this method"
}
|
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 |
|
|
You don't have access to use this method |
You do not have access to this method |
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 |