[{"data":1,"prerenderedAt":9},["ShallowReactive",2],{"docs-workday\u002Ftime-control-settings":3,"docs-tabs-workday\u002Ftime-control-settings":6},{"content":4,"lastmod":5},"# Time-control settings\n\nTime-control settings shared by all employees of the Bitrix24 account: whether time control is on, who is asked for an absence report, and who can access monthly reports.\n\n**Scope:** `timeman` | **Base URL:** `https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1` | **Authorization:** `X-Api-Key`\n\n## Operations\n\n- [Get time-control settings](.\u002Ftime-control-settings-list.md) — `GET \u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings`\n- [Update time-control settings](.\u002Ftime-control-settings-update.md) — `PATCH \u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings`\n\n## Access\n\nPermissions are checked for the credential owner: for a personal key, this is the key owner; for an app key, the user whose session token is passed in `Authorization`. A Bitrix24 account administrator can read and change the settings; an employee without administrator rights gets `403 BITRIX_ACCESS_DENIED`. The Bitrix24 application behind the app key needs only the `timeman` permission. A `READONLY` key can read the settings but cannot change them.\n\n## Typical scenario\n\n1. Read the current settings: [Get time-control settings](.\u002Ftime-control-settings-list.md).\n2. Pass only the fields you need to change: [Update time-control settings](.\u002Ftime-control-settings-update.md). The response contains all settings after the write.\n\n## See also\n\n- [Get time-control report settings](\u002Fdocs\u002Fworkday\u002Ftime-control-report-settings)\n- [Get the monthly absence report](\u002Fdocs\u002Fworkday\u002Ftime-control-reports)\n- [Explain an absence](\u002Fdocs\u002Fworkday\u002Ftime-control-explain)\n- [Workday](\u002Fdocs\u002Fworkday)\n","2026-10-12",{"time-control-settings-list.md":7,"time-control-settings-update.md":8},"## Get time-control settings\n\n`GET \u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings`\n\nReturns the time-control settings shared by all employees of the Bitrix24 account. Call it before updating the settings to read the current values.\n\nRequires the `timeman` scope. Bitrix24 checks the credential owner's permissions: for a personal key, that is the key owner; for an app key, the user whose session token is passed in `Authorization`. A Bitrix24 account administrator can read the settings; an employee without administrator permissions gets `403 BITRIX_ACCESS_DENIED`. The Bitrix24 application behind an app key only needs the `timeman` permission. A `READONLY` key can read the settings. Updating the settings is described on the [Update time-control settings](\u002Fdocs\u002Fworkday\u002Ftime-control-settings-update) page.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\nconst { data } = await res.json()\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\nconst { data } = await res.json()\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on a successful request |\n| `data` | object | Time-control settings shared by the entire Bitrix24 account |\n| `data.active` | boolean | Whether time control is enabled. When `false`, an employee without subordinates cannot access monthly reports on the [Get the monthly absence report](\u002Fdocs\u002Fworkday\u002Ftime-control-reports) page, including their own |\n| `data.minimumIdleForReport` | integer | Minimum absence, in minutes, for which an employee is asked for a report. At least `1` |\n| `data.registerOffline` | boolean | Whether to record when an employee is offline |\n| `data.registerIdle` | boolean | Whether to record when an employee is away |\n| `data.registerDesktop` | boolean | Whether to record work in the Bitrix24 desktop app |\n| `data.reportRequestType` | string | Who is asked for an absence report: `all` — all employees, `user` — employees listed in `reportRequestUsers`, `none` — nobody |\n| `data.reportRequestUsers` | integer[] \\| string[] | IDs of employees who are asked for a report. With `reportRequestType: \"user\"` — a list of IDs. Elements arrive as numbers or strings, depending on how the setting was saved: compare them after converting to a number. List: [List employees](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `data.reportSimpleType` | string | Who has access to the simple report — their own monthly time-control report: `all` — all employees, `user` — employees listed in `reportSimpleUsers`. `none` never arrives in the response: that value is stored as `user` with an empty `reportSimpleUsers` |\n| `data.reportSimpleUsers` | integer[] \\| string[] | IDs of employees with the simple report. With `reportSimpleType: \"user\"` — a list of IDs; an empty array means the simple report is not assigned to any employee. With `all` — an empty array. Elements are numbers or strings, as in `reportRequestUsers`. List: [List employees](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `data.reportFullType` | string | Who has access to the full report — the monthly reports of all employees: `all` — all employees, `user` — employees listed in `reportFullUsers`. `none` never arrives in the response: that value is stored as `user` with an empty `reportFullUsers` |\n| `data.reportFullUsers` | integer[] \\| string[] | IDs of employees with the full report. With `reportFullType: \"user\"` — a list of IDs; an empty array means the full report is not assigned to any employee. With `all` — an empty array. Elements are numbers or strings, as in `reportRequestUsers`. List: [List employees](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"active\": false,\n    \"minimumIdleForReport\": 15,\n    \"registerOffline\": true,\n    \"registerIdle\": true,\n    \"registerDesktop\": true,\n    \"reportRequestType\": \"user\",\n    \"reportRequestUsers\": [\"1\"],\n    \"reportSimpleType\": \"all\",\n    \"reportSimpleUsers\": [],\n    \"reportFullType\": \"all\",\n    \"reportFullUsers\": []\n  }\n}\n```\n\n## Error response example\n\n403 — the credential owner is not a Bitrix24 account administrator:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"BITRIX_ACCESS_DENIED\",\n    \"message\": \"You don't have access to user this method\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 403 | `BITRIX_ACCESS_DENIED` | The credential owner is not a portal administrator |\n| 409 | `TIMEMAN_MODULE_NOT_ENABLED` | Time Management is not available on this portal: the Time Management tool is switched off in the portal settings, or the module is not included in the plan |\n| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable or returned a response of an unexpected shape |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header was not passed |\n| 401 | `TOKEN_MISSING` | An app key was sent without a session token in `Authorization: Bearer` |\n| 401 | `INVALID_SESSION` | The session token is invalid or has expired |\n| 403 | `SCOPE_DENIED` | The key does not have the `timeman` scope |\n| 429 | `RATE_LIMITED` | The general request limit was exceeded; the retry delay is in the `Retry-After` header |\n\nThe full list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Update time-control settings](\u002Fdocs\u002Fworkday\u002Ftime-control-settings-update)\n- [Time-control settings](\u002Fdocs\u002Fworkday\u002Ftime-control-settings)\n- [Get the monthly absence report](\u002Fdocs\u002Fworkday\u002Ftime-control-reports)\n- [Explain an absence](\u002Fdocs\u002Fworkday\u002Ftime-control-explain)\n- [Workday](\u002Fdocs\u002Fworkday)\n","## Update time-control settings\n\n`PATCH \u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings`\n\nChanges the time-control settings for the entire Bitrix24 account: the passed fields are overwritten, and the rest keep their previous values.\n\nRequires the `timeman` scope. Permissions are checked for the credential owner: for a personal key, that is the key owner; for an app key, the user whose session token is passed in `Authorization`. A Bitrix24 account administrator can change the settings; an employee without administrator rights gets `403 BITRIX_ACCESS_DENIED`. The Bitrix24 application behind the app key needs only the `timeman` permission. A `READONLY` key cannot change the settings. For the current values, see [Get time-control settings](\u002Fdocs\u002Fworkday\u002Ftime-control-settings-list).\n\n## Request fields (body)\n\nAll fields are optional, but the body must contain at least one. The fields come in pairs: `reportRequestType` and `reportRequestUsers`, `reportSimpleType` and `reportSimpleUsers`, `reportFullType` and `reportFullUsers`. Pass the `user` type together with its list in the same request, and pass a list only together with the `user` type.\n\n| Field | Type | Description |\n|------|-----|----------|\n| `active` | boolean | Switches time control on or off. With `false`, an employee without subordinates has no access to monthly reports on the [Get the monthly absence report](\u002Fdocs\u002Fworkday\u002Ftime-control-reports) page, including their own |\n| `minimumIdleForReport` | integer | Minimum absence, in minutes, for which an employee is asked for a report. A value below `1` is saved as `1` |\n| `registerOffline` | boolean | Whether to record when an employee is offline |\n| `registerIdle` | boolean | Whether to record when an employee is away |\n| `registerDesktop` | boolean | Whether to record work in the Bitrix24 desktop app |\n| `reportRequestType` | string | Whom to ask for an absence report: `all` — all employees, `user` — employees from `reportRequestUsers`, `none` — nobody |\n| `reportRequestUsers` | integer[] | IDs of the employees who are asked for a report — positive integers. An empty array is allowed. List: [List employees](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `reportSimpleType` | string | Who has access to the simple report — their own monthly time-control report: `all` — all employees, `user` — employees from `reportSimpleUsers`, `none` — nobody. `none` is saved as `user` with an empty `reportSimpleUsers` |\n| `reportSimpleUsers` | integer[] | IDs of the employees with the simple report — positive integers. An empty array is allowed. List: [List employees](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `reportFullType` | string | Who has access to the full report — the monthly reports of all employees: `all` — all employees, `user` — employees from `reportFullUsers`, `none` — nobody. `none` is saved as `user` with an empty `reportFullUsers` |\n| `reportFullUsers` | integer[] | IDs of the employees with the full report — positive integers. An empty array is allowed. List: [List employees](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"reportSimpleType\": \"user\", \"reportSimpleUsers\": [103, 107]}'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"reportSimpleType\": \"user\", \"reportSimpleUsers\": [103, 107]}'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ reportSimpleType: 'user', reportSimpleUsers: [103, 107] }),\n})\nconst { data } = await res.json()\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fworkday\u002Ftime-control\u002Fsettings', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ reportSimpleType: 'user', reportSimpleUsers: [103, 107] }),\n})\nconst { data } = await res.json()\n```\n\n## Response fields\n\nThe response contains all of the account's time-control settings after the write, not only the changed fields. For a detailed description of each field, see [Get time-control settings](\u002Fdocs\u002Fworkday\u002Ftime-control-settings-list).\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on a successful write |\n| `data` | object | Time-control settings after the write |\n| `data.active` | boolean | Whether time control is switched on |\n| `data.minimumIdleForReport` | integer | Minimum absence, in minutes, for which a report is requested |\n| `data.registerOffline` | boolean | Whether to record when an employee is offline |\n| `data.registerIdle` | boolean | Whether to record when an employee is away |\n| `data.registerDesktop` | boolean | Whether to record work in the Bitrix24 desktop app |\n| `data.reportRequestType` | string | `all`, `user` or `none` |\n| `data.reportRequestUsers` | integer[] \\| string[] | IDs of the employees who are asked for a report |\n| `data.reportSimpleType` | string | `all` or `user`. If you write `none`, it comes back as `user` with an empty `reportSimpleUsers` |\n| `data.reportSimpleUsers` | integer[] \\| string[] | IDs of the employees with the simple report |\n| `data.reportFullType` | string | `all` or `user`. If you write `none`, it comes back as `user` with an empty `reportFullUsers` |\n| `data.reportFullUsers` | integer[] \\| string[] | IDs of the employees with the full report |\n\nIDs written by this method come back as numbers. IDs saved earlier by other means may come back as strings, like `reportRequestUsers` in the example below. Compare IDs after converting them to numbers.\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"active\": false,\n    \"minimumIdleForReport\": 15,\n    \"registerOffline\": true,\n    \"registerIdle\": true,\n    \"registerDesktop\": true,\n    \"reportRequestType\": \"user\",\n    \"reportRequestUsers\": [\"1\"],\n    \"reportSimpleType\": \"user\",\n    \"reportSimpleUsers\": [103, 107],\n    \"reportFullType\": \"all\",\n    \"reportFullUsers\": []\n  }\n}\n```\n\n## Error response example\n\n400 — the `reportRequestUsers` list is passed without `reportRequestType: \"user\"`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"reportRequestUsers requires the matching type user\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 400 | `INVALID_PARAMS` | The body is empty or not an object: `Provide at least one setting` |\n| 400 | `INVALID_PARAMS` | Unknown field: `Unknown setting: \u003Cfield>` |\n| 400 | `INVALID_PARAMS` | Invalid value type: `active` or `register*` is not `true` or `false`, `minimumIdleForReport` is not an integer, `*Type` is not `all`, `user` or `none`, `*Users` is not an array of positive integers |\n| 400 | `INVALID_PARAMS` | Type `user` is passed without its list, or a list is passed without type `user`: `reportRequestType requires the matching users array`, `reportRequestUsers requires the matching type user` |\n| 403 | `BITRIX_ACCESS_DENIED` | The credential owner is not a Bitrix24 account administrator |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is in `READONLY` mode |\n| 409 | `TIMEMAN_MODULE_NOT_ENABLED` | Time Management is not available on this portal: the Time Management tool is switched off in the portal settings, or the module is not included in the plan |\n| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable or returned a response of an unexpected shape |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header was not passed |\n| 401 | `TOKEN_MISSING` | An app key was sent without a session token in `Authorization: Bearer` |\n| 401 | `INVALID_SESSION` | The session token is invalid or has expired |\n| 403 | `SCOPE_DENIED` | The key lacks the `timeman` scope |\n| 429 | `RATE_LIMITED` | The general request limit was exceeded; the retry delay is in the `Retry-After` header |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n- The body is validated as a whole before the write: if any field is invalid, no settings are changed, not even the valid fields from the same request.\n- Employee IDs in `*Users` are not checked for existence: a nonexistent ID is saved without an error.\n\n## See also\n\n- [Get time-control settings](\u002Fdocs\u002Fworkday\u002Ftime-control-settings-list)\n- [Time-control settings](\u002Fdocs\u002Fworkday\u002Ftime-control-settings)\n- [Get the monthly absence report](\u002Fdocs\u002Fworkday\u002Ftime-control-reports)\n- [List employees](\u002Fdocs\u002Fentities\u002Fusers\u002Flist)\n- [Workday](\u002Fdocs\u002Fworkday)\n",1795000592960]