For AI agents: markdown of this page — /docs-content-en/workday/time-control-settings.md documentation index — /llms.txt

Time-control settings

Read and update time-control settings for the entire account. Only a Bitrix24 administrator can read or update them. A change affects the entire account, rather than only the key owner.

Method Path Bitrix24 method
GET /v1/workday/time-control/settings timeman.timecontrol.settings.get
PATCH /v1/workday/time-control/settings timeman.timecontrol.settings.set

PATCH fields: active, minimumIdleForReport (integer minutes), registerOffline, registerIdle, registerDesktop (boolean); reportRequestType, reportSimpleType, reportFullType (all, user, none) and matching reportRequestUsers, reportSimpleUsers, reportFullUsers (arrays of positive IDs). Type user requires its list in the same request; a list requires its matching type user. An empty list is accepted. Unknown fields, an empty PATCH and malformed values return 400 before calling Bitrix24. Supplied fields change; omitted fields remain unchanged. PATCH returns reread settings.

JSON
{"reportRequestType":"user","reportRequestUsers":[101]}

Access and errors

Key scope: timeman. Bitrix24 enforces user permissions. 400 INVALID_PARAMS means invalid input; 403 means missing scope or Bitrix24 permissions; writes with a READONLY key return 403 WRITE_BLOCKED_READONLY_KEY; 409 TIMEMAN_MODULE_NOT_ENABLED means unavailable Time Management; 422 BITRIX_ERROR forwards a Bitrix24 business refusal with its text. Webhook credentials are scrubbed from responses.

All endpoints