Для AI-агентов: markdown этой страницы — /docs-content/workday/records-comments.md индекс документации — /llms.txt
Получить комментарии к рабочему дню
Метод в процессе раскатки — обновление
timeman 26.600.0. Доступен не на всех порталах. Новое чтение дополнительно включается командой VibeCode; при выпуске оно выключено. До включения или на портале без нового метода API отвечает422 METHOD_NOT_YET_AVAILABLE. Различайте раскатку по коду ошибки, а не по статусу: прочие отказы Битрикс24 приходят с тем же статусом 422 и кодомBITRIX_ERROR. Существующее чтение отчётов и дней продолжает работать.
GET /v1/workday/records/:recordId/comments
Читает опубликованные комментарии рабочего дня из ленты и со страницы «Отчёт за день». ID объекта берите из истории рабочих дней.
Скоуп: timeman
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
ПараметрrecordId (path) |
Типinteger | Обязательныйда | ОписаниеПоложительный целый ID не больше 9007199254740991 из истории рабочих дней |
Параметрlimit (query) |
Типinteger | Обязательныйнет | ОписаниеРазмер страницы: 1–50, по умолчанию 50 |
Параметрoffset (query) |
Типinteger | Обязательныйнет | ОписаниеСмещение: 0–999999999, по умолчанию 0; несовместим с page |
Параметрpage (query) |
Типinteger | Обязательныйнет | ОписаниеНомер страницы от 1; несовместим с offset. Вычисленное смещение не больше 999999999 |
Примеры
curl — личный ключ
curl -H "X-Api-Key: YOUR_API_KEY" \
"https://vibecode.bitrix24.tech/v1/workday/records/79/comments?limit=50&offset=0"
curl — OAuth-приложение
curl -H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
"https://vibecode.bitrix24.tech/v1/workday/records/79/comments?limit=50&offset=0"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/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-приложение
const res = await fetch('https://vibecode.bitrix24.tech/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)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | Описаниеtrue при успешном ответе |
Полеdata |
Типarray | ОписаниеКомментарии запрошенной страницы; пустой массив допустим |
Полеdata[].id |
Типinteger | null | ОписаниеID комментария; положительный, если не null |
Полеdata[].recordId |
Типinteger | ОписаниеID из истории рабочих дней, совпадает с ID в пути запроса |
Полеdata[].authorId |
Типinteger | null | ОписаниеID пользователя Битрикс24; допустим 0 |
Полеdata[].text |
Типstring | null | ОписаниеИсходный BBCode, включая [USER=…] и [DISK FILE ID=…] |
Полеdata[].textPlain |
Типstring | null | ОписаниеТекст без BBCode и HTML |
Полеdata[].createdAt |
Типstring | null | ОписаниеДата DATE_ATOM с сохранённым часовым поясом сервера |
Полеmeta.limit |
Типinteger | ОписаниеПрименённый размер страницы |
Полеmeta.offset |
Типinteger | ОписаниеПрименённое смещение |
Полеmeta.hasMore |
Типboolean | ОписаниеСтраница заполнена, поэтому могут быть ещё комментарии |
Полеmeta.nextOffset |
Типinteger | null | ОписаниеСледующее смещение при полной странице; иначе null |
Пример ответа
{
"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 }
}
Пример ответа при ошибке
502 — портал вернул повреждённые данные комментариев:
{
"success": false,
"error": {
"code": "BITRIX_UNAVAILABLE",
"message": "Bitrix24 returned an unexpected comment response."
}
}
Ошибки
| HTTP | Код | Причина |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ПричинаНекорректный ID, пагинация, неизвестные или повторённые параметры |
| HTTP409 | КодTIMEMAN_MODULE_NOT_ENABLED |
ПричинаИнструмент учёта времени выключен |
| HTTP422 | КодMETHOD_NOT_YET_AVAILABLE |
ПричинаНовое чтение не включено в VibeCode или метод отсутствует на портале |
| HTTP422 | КодBITRIX_ERROR |
ПричинаПрочие отказы Битрикс24; пояснение в message |
| HTTP502 | КодBITRIX_UNAVAILABLE |
ПричинаПортал недоступен или вернул повреждённый ответ; частичной выдачи нет |
| HTTP401 | КодMISSING_API_KEY |
ПричинаНе передан X-Api-Key |
| HTTP401 | КодINVALID_API_KEY |
ПричинаAPI-ключ не опознан |
| HTTP401 | КодKEY_EXPIRED |
ПричинаСрок действия API-ключа истёк |
| HTTP401 | КодTOKEN_MISSING |
ПричинаНет портальных учётных данных |
| HTTP402 | КодACCOUNT_FROZEN |
ПричинаБаланс портала заморожен |
| HTTP403 | КодSCOPE_DENIED |
ПричинаУ ключа нет скоупа timeman |
| HTTP403 | КодBITRIX_ACCESS_DENIED |
ПричинаНет права доступа к объекту |
| HTTP429 | КодRATE_LIMITED |
ПричинаПревышен лимит темпа этого эндпоинта |
| HTTP429 | КодRATE_LIMITED |
ПричинаПревышен лимит запросов портала Битрикс24 |
| HTTP500 | КодINTERNAL_ERROR |
ПричинаНепредвиденная внутренняя ошибка |
Общие ошибки API описаны в разделе Ошибки.
Известные особенности
Комментарии отсортированы по возрастанию ID. Передавайте meta.nextOffset как offset, пока meta.hasMore равно true. Полная страница означает, что комментарии могут продолжаться: после последней полной страницы может понадобиться ещё один пустой запрос. Общее количество не подставляется.
Произвольные filter и select, неизвестные и повторённые параметры отклоняются. Служебные сообщения исключены.
Ключи READONLY поддерживаются. Личный ключ читает правами владельца вебхука; ключ приложения — правами пользователя учётных данных Битрикс24. Доступны свои объекты и объекты сотрудников, чей учёт времени вызывающий вправе смотреть. Недоступный или несуществующий объект приводит к 403 на весь запрос.
Настроенный лимит — 30 запросов в минуту на пару ключа и пользователя. Действующее значение передаётся в x-ratelimit-limit.