For AI agents: markdown of this page — /docs-content-en/workday/work-reports/get.md documentation index — /llms.txt

Read a work report

GET /v1/workday/work-reports/:id

Returns a single work report by the report ID and the ID of the employee it belongs to.

Requires the timeman scope. Bitrix24 checks the credential owner’s permissions. READONLY keys can read reports and cannot write them.

Parameters

Parameter Type Required Default Description
id (path) integer yes — Report ID. List: GET /v1/workday/work-reports
userId (query) integer yes — ID of the employee the report belongs to — the userId field of the report. List: GET /v1/users. Any other ID returns 403 BITRIX_ACCESS_DENIED

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/workday/work-reports/143?userId=101" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/workday/work-reports/143?userId=101" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

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

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/workday/work-reports/143?userId=101', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Response fields

Field Type Description
success boolean true when the request succeeds
data object The report. All fields — Report fields

Response example

The main report fields are shown. For the full list, see Report fields:

JSON 
{
  "success": true,
  "data": {
    "id": 143,
    "userId": 101,
    "active": true,
    "reportType": "day",
    "reportDate": "2026-10-06T18:22:40.000Z",
    "dateFrom": "2026-10-05T21:00:00.000Z",
    "dateTo": "2026-10-05T21:00:00.000Z",
    "report": "Weekly report",
    "type": "REPORT",
    "mark": "N",
    "approve": "Y"
  }
}

Error response example

404 — no report with this id exists:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Report not found."
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS userId is missing, id or userId is not a positive integer, an unknown parameter is passed, or a parameter is passed twice
404 ENTITY_NOT_FOUND No report with this id exists
403 BITRIX_ACCESS_DENIED userId does not match the employee the report belongs to, or the credential owner lacks Bitrix24 permissions for this employee's reports
409 TIMEMAN_MODULE_NOT_ENABLED Time Management is not available on this portal
422 BITRIX_ERROR Bitrix24 refused the operation
502 BITRIX_UNAVAILABLE Bitrix24 is unavailable or returned a response of an unexpected shape
401 MISSING_API_KEY The X-Api-Key header was not passed
401 TOKEN_MISSING An app key was sent without a session token in Authorization: Bearer
401 INVALID_SESSION The session token is invalid or has expired
403 SCOPE_DENIED The key lacks the timeman scope
429 RATE_LIMITED The report read limit or the general request limit was exceeded

The full list of common API errors — Errors.

See also