#Current status

GET /v1/workday/status

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

#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 other fields are absent. See "Degenerate response with no workday record" under "Known specifics".

#Possible `status` values

#Response example

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

An employee with no workday record — the response collapses 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

The full list of common API errors — Errors.

#Known specifics

• State after closing. After the day is closed, the endpoint keeps returning the details of the last day (CLOSED, with timeFinish filled in) until the next one is opened — the report for the closed day is available through the same request.
• The record may be from any date — check timeStart against today. status and timeStart describe the employee's most recent workday record, which can be arbitrarily old: Bitrix24 timeman.status returns the last record regardless of age. A day CLOSED three years ago, or a day left EXPIRED (opened and never closed) five days ago, are both returned verbatim — neither means "today". This endpoint has no "today only" filter, so to decide whether the day belongs to the current date, compare the date part of timeStart with the current date on your side before trusting status. For a team-status dashboard, treat a record whose timeStart is not today as "no workday started today".
• Degenerate response with no workday record. When the requested employee has no workday record, data contains only the status field. The other fields (timeStart, timeFinish, duration, and the rest) are absent from the response, so check that a field is present before reading it. There is no record, for example, for an employee whose day has never been opened.
• Closing an expired day. In the EXPIRED status the day is closed retroactively. Pass the time parameter to POST /v1/workday/close with a date equal to the day's start date — the timeStart value from this endpoint's response — together with the required report. A time date other than the start date returns 422.

#See also

• Open workday — POST /v1/workday/open.
• Close workday — POST /v1/workday/close.
• Pause — POST /v1/workday/pause.
• Tracking settings — GET /v1/workday/settings.
• Workday — section overview.