List workday comments

Method rollout — update timeman 26.600.0. Not available on every account. The Vibecode team also controls release of these new reads; they are off by default. Before enablement or on an account without the new method, the API returns 422 METHOD_NOT_YET_AVAILABLE. Detect the rollout by the error code, not by the status: other Bitrix24 refusals arrive with the same 422 status and the BITRIX_ERROR code. Existing report and workday reads keep working.

GET /v1/workday/records/:recordId/comments

Reads published workday comments from the Feed and the Daily report page. Get the object ID from the workday history.

Scope: timeman

Parameters

Examples

curl — personal key

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://vibecode.bitrix24.com/v1/workday/records/79/comments?limit=50&offset=0"

curl — OAuth application

curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  "https://vibecode.bitrix24.com/v1/workday/records/79/comments?limit=50&offset=0"

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/workday/records/79/comments?limit=50&offset=0', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const body = await res.json()
if (!res.ok) throw new Error(`${body.error?.code ?? res.status}: ${body.error?.message ?? res.statusText}`)
console.log(body.data, body.meta)

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/workday/records/79/comments?limit=50&offset=0', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const body = await res.json()
if (!res.ok) throw new Error(`${body.error?.code ?? res.status}: ${body.error?.message ?? res.statusText}`)
console.log(body.data, body.meta)

Response fields

Response example

{
  "success": true,
  "data": [{
    "id": 1,
    "recordId": 79,
    "authorId": 7,
    "text": "[USER=7]Alex[/USER] [DISK FILE ID=4]",
    "textPlain": "Alex",
    "createdAt": "2026-11-11T10:00:00+00:00"
  }],
  "meta": { "limit": 50, "offset": 0, "hasMore": false, "nextOffset": null }
}

Error response example

502 — the account returned malformed comment data:

{
  "success": false,
  "error": {
    "code": "BITRIX_UNAVAILABLE",
    "message": "Bitrix24 returned an unexpected comment response."
  }
}

Errors

For common API errors, see Errors.

Known specifics

Comments are sorted by ascending ID. Pass meta.nextOffset as offset while meta.hasMore is true. A full page means that more comments may exist: one final empty request may be needed after the last full page. No total count is invented.

Arbitrary filter and select, unknown parameters and repeated parameters are refused. Service messages are excluded.

READONLY keys are supported. Personal keys read with the webhook owner's permissions; application keys use the Bitrix24 credential user's permissions. You can read your own objects and those of employees whose working time you may view. An inaccessible or nonexistent object returns 403 for the whole request.

The configured rate limit is 30 requests per minute per key and user pair. The effective limit is reported in x-ratelimit-limit.

See also

• Work reports
• Workday history