Для AI-агентов: markdown этой страницы — /docs-content/workday/settings.md индекс документации — /llms.txt

Настройки учёта

GET /v1/workday/settings

Возвращает настройки учёта рабочего времени, действующие на портале для текущего пользователя или для указанного сотрудника: разрешено ли рабочее время, свободный ли график, допустимое начало и завершение дня, минимальная длительность.

Параметры

Параметр Тип Обязательный Описание
userId number нет Идентификатор сотрудника. По умолчанию — пользователь, которому принадлежат токены ключа. Настройки другого сотрудника Битрикс24 отдаёт только тому, у кого есть право управлять рабочим временем всех сотрудников. Без этого права запрос отклоняется с ошибкой 422 BITRIX_ERROR

Примеры

curl — личный ключ

Terminal 
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/workday/settings

curl — настройки другого сотрудника

Terminal 
curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://vibecode.bitrix24.tech/v1/workday/settings?userId=503"

curl — OAuth-приложение

Terminal 
curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.tech/v1/workday/settings

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/settings', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Учёт времени включён:', data.ufTimeman)
console.log('Свободный график:', data.ufTmFree)
console.log('Допустимое начало до:', data.ufTmMaxStart)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/settings', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean true при успешном ответе
data.ufTimeman boolean Включён ли учёт рабочего времени для пользователя
data.ufTmFree boolean Свободный график. true — нет ограничений по началу и завершению дня; false — действуют поля ufTmMaxStart/ufTmMinFinish/ufTmMinDuration
data.ufTmMaxStart string Самое позднее допустимое время начала дня в формате HH:MM:SS
data.ufTmMinFinish string Самое раннее допустимое время завершения дня в формате HH:MM:SS
data.ufTmMinDuration string Минимальная длительность рабочего дня в формате HH:MM:SS
data.ufTmAllowedDelta string Допустимое отклонение от установленного времени начала и завершения в формате HH:MM:SS
data.admin boolean Является ли пользователь администратором учёта рабочего времени. Возвращается только в собственных настройках, для другого сотрудника поля нет

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "ufTimeman": true,
    "ufTmFree": true,
    "ufTmMaxStart": "09:15:00",
    "ufTmMinFinish": "17:45:00",
    "ufTmMinDuration": "08:00:00",
    "ufTmAllowedDelta": "00:15:00",
    "admin": true
  }
}

Пример ответа при ошибке

403 — у ключа нет скоупа timeman:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'timeman' scope"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS userId не является положительным целым числом
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Ключ не опознан: такой строки на платформе нет
401 KEY_EXPIRED Срок действия API-ключа истёк
401 TOKEN_MISSING Ключу не настроены OAuth-токены для портала
402 ACCOUNT_FROZEN Баланс портала заморожен
403 SCOPE_DENIED У ключа нет скоупа timeman
409 TIMEMAN_MODULE_NOT_ENABLED На портале нет учёта рабочего времени: модуль не установлен (не входит в тариф) либо инструмент выключен в настройках портала. Попросите администратора портала включить учёт рабочего времени — до этого так отвечают все методы timeman.*
422 BITRIX_ERROR Битрикс24 отклонил запрос — текст в message
429 RATE_LIMITED Превышен лимит запросов к Битрикс24
502 BITRIX_UNAVAILABLE Портал Битрикс24 недоступен

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Привязка к токенам ключа. Без userId ответ соответствует пользователю, которому принадлежат токены ключа. У разных сотрудников значения могут отличаться, если для них настроены разные графики работы.
  • Признак учёта по сотруднику. Чтобы узнать, ведётся ли учёт рабочего времени у конкретного сотрудника, передайте его userId и прочитайте data.ufTimeman. Право руководителя только на своих подчинённых для этого недостаточно: Битрикс24 требует права на рабочее время всех сотрудников.

Смотрите также