#Поставить на паузу

POST /v1/workday/pause

Приостанавливает текущий рабочий день. Статус переходит в PAUSED, длительность паузы накапливается до возобновления или закрытия дня. Тело запроса может быть пустым.

#Поля запроса (body)

Поле Тип Обяз. Описание
userId number нет Идентификатор сотрудника. По умолчанию — пользователь, которому принадлежат токены ключа

Тело может быть пустым: {}.

#Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/workday/pause \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/workday/pause \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/pause', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const { data } = await res.json()
console.log('Статус:', data.status)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/pause', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const { data } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean true при успешной постановке на паузу
data.status string Статус после паузы — PAUSED
data.timeStart string Дата и время начала дня (ISO 8601)
data.timeFinish string Дата и время начала текущей паузы (ISO 8601)
data.duration string Длительность дня в формате HH:MM:SS без учёта пауз
data.timeLeaks string Суммарная длительность пауз за день в формате HH:MM:SS
data.active boolean Признак активной записи рабочего дня
data.ipOpen string IP-адрес начала дня
data.ipClose string IP-адрес завершения дня. Пустая строка для дня, который ещё не был закрыт
data.latOpen number Географическая широта точки начала
data.lonOpen number Географическая долгота точки начала
data.latClose number Географическая широта точки завершения
data.lonClose number Географическая долгота точки завершения
data.tzOffset number Смещение часового пояса сотрудника в секундах (зависит от настроек сотрудника на портале; пример 10800 соответствует UTC+3)

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

JSON 
{
  "success": true,
  "data": {
    "status": "PAUSED",
    "timeStart": "2026-05-05T09:00:00+03:00",
    "timeFinish": "2026-05-05T13:00:00+03:00",
    "duration": "04:00:00",
    "timeLeaks": "00:00:00",
    "active": true,
    "ipOpen": "203.0.113.10",
    "ipClose": "",
    "latOpen": 0,
    "lonOpen": 0,
    "latClose": 0,
    "lonClose": 0,
    "tzOffset": 10800
  }
}

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

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

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

#Ошибки

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

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

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

  • Снятие паузы — отдельный вызов. Повторный /pause оставляет день в статусе PAUSED без изменений. Чтобы продолжить день после паузы, используйте `POST /v1/workday/open` — он переводит день обратно в OPENED.
  • Возобновление закрытого дня. Если день уже в статусе CLOSED, вызов возвращает текущее состояние без изменений. Чтобы продолжить ранее закрытый день, используйте `POST /v1/workday/open`.

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