Current status

GET /v1/workday/status

Returns the current state of an employee's workday: status, start and finish time, duration, pauses.

Parameters

Examples

curl — personal key

curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.com/v1/workday/status

curl — another employee's status

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

curl — OAuth application

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

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/workday/status', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Status:', data.status)
console.log('Active day:', data.active)
console.log('Duration:', data.duration)

JavaScript — another employee's status

const res = await fetch('https://vibecode.bitrix24.com/v1/workday/status?userId=503', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()

JavaScript — OAuth application

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

Response fields

When the requested employee has no workday record, data contains only status — the remaining fields are absent. See "Degenerate response without a day record" in "Known specifics".

Possible `status` values

Response example

{
  "success": true,
  "data": {
    "status": "OPENED",
    "id": 1,
    "timeStart": "2026-05-05T09:00:00+02:00",
    "timeFinish": null,
    "duration": "00:00:00",
    "timeLeaks": "00:30:00",
    "active": true,
    "ipOpen": "203.0.113.10",
    "ipClose": "",
    "latOpen": 0,
    "lonOpen": 0,
    "latClose": 0,
    "lonClose": 0,
    "tzOffset": 7200
  }
}

For an employee with no workday record, the response degenerates to a single status field:

{
  "success": true,
  "data": {
    "status": "CLOSED"
  }
}

Error response example

403 — the key lacks the timeman scope:

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

Errors

Full list of common API errors — Errors.

Known specifics

• State after closing. After the day is closed, the endpoint keeps returning the last day's data (CLOSED, with timeFinish filled in) until the next one is opened — the report on a closed day is available through the same request.
• The record may be of any age — compare timeStart with today's date. status and timeStart describe the employee's last workday record, and it may be arbitrarily old: Bitrix24 timeman.status returns the last record regardless of its age. Both a day CLOSED three years ago and a day left EXPIRED (opened and not closed) five days ago are returned as is — neither of them means "today". The endpoint has no "today only" filter, so to tell whether the day belongs to the current date, compare the date from timeStart with today's date on your side before trusting status. For a team dashboard, treat a record whose timeStart is not today as "the workday has not been started today".
• Degenerate response without a day record. If the requested employee has no workday record, data contains only the status field. The remaining fields (timeStart, timeFinish, duration and others) are absent from the response, so check that a field is present before reading it. The record is missing, for example, for an employee whose day has never been opened.
• Closing an expired day. A day in the EXPIRED status is closed retroactively. In POST /v1/workday/close, pass the time parameter with a date equal to the day's open date — that is the timeStart value from this endpoint's response — together with the mandatory report. A time date that differs from the open date returns 422.

See also

• Open workday
• Close workday
• Pause
• Tracking settings
• Workday history
• Workday