Для AI-агентов: markdown этой страницы — /docs-content/feed/posts/list.md индекс документации — /llms.txt
Список постов
GET /v1/posts
Возвращает посты Ленты новостей Битрикс24, доступные текущему API-ключу, в нормализованном виде: ключи в camelCase, флаги булевыми, числовые поля числами.
Параметры
| Параметр | Тип | Обяз. | По умолч. | Описание |
|---|---|---|---|---|
limit (query) |
number | нет | 50 | Количество постов в ответе. Допустимый диапазон от 1 до 200. Страница ленты Битрикс24 фиксирована в 50 записей — при limit больше 50 платформа склеивает до четырёх страниц в один ответ. Значение больше 200 возвращает 400 INVALID_LIMIT |
offset (query) |
number | нет | 0 | Смещение для пагинации. Целое неотрицательное число |
Пагинация. За один запрос приходит до 200 постов. Чтобы получить следующую порцию, передайте в offset значение meta.nextOffset из ответа предыдущего запроса. Поле meta.nextOffset присутствует, только когда есть следующая страница. Если его нет, посты закончились.
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/posts?limit=3" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/posts?limit=3" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/posts?limit=3', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data, meta } = await res.json()
console.log(`Постов: ${data.length} из ${meta.total}`)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/posts?limit=3', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data, meta } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
success |
boolean | Всегда true при успехе |
data |
array | Массив постов |
data[].id |
number | ID поста. Используется в пути PATCH /v1/posts/:id и в URL поста |
data[].blogId |
number | ID блога, к которому относится пост |
data[].publishStatus |
string | Статус публикации (P — опубликован) |
data[].title |
string | Заголовок поста |
data[].detailText |
string | Текст поста |
data[].authorId |
number | ID автора. Список: GET /v1/users |
data[].enableComments |
boolean | Разрешены ли комментарии к посту |
data[].numComments |
string | Количество комментариев строкой (например, "2") |
data[].code |
string | null | Символьный код поста |
data[].micro |
boolean | Микропост (без заголовка) |
data[].datePublish |
string | Дата публикации (ISO 8601 с часовым поясом) |
data[].categoryId |
number[] | ID категорий/тегов поста. Всегда массив: [] — категорий нет, [11] — одна, [5, 7, 9] — несколько |
data[].hasSocnetAll |
boolean | Пост адресован всем сотрудникам |
data[].hasTags |
boolean | null | В посте есть теги |
data[].hasImages |
boolean | null | В посте есть изображения |
data[].hasProps |
boolean | null | В посте есть свойства |
meta.total |
number | Общее количество постов, доступных ключу |
meta.pageSize |
number | Размер страницы Битрикс24 — всегда 50 |
meta.returned |
number | Фактическое число постов в ответе |
meta.requestedLimit |
number | Значение переданного limit. Присутствует, только если параметр был передан |
meta.nextOffset |
number | Смещение следующей страницы. Присутствует, только если есть следующая страница — передайте его в offset следующего запроса |
Пример ответа
Ответ содержит только перечисленные выше поля — служебные и пользовательские поля Битрикса (UF_*, FILES и т. п.) не отдаются.
{
"success": true,
"data": [
{
"id": 293,
"blogId": 1,
"publishStatus": "P",
"title": "Объявление",
"detailText": "Текст объявления для сотрудников",
"authorId": 1,
"enableComments": true,
"numComments": "0",
"code": null,
"micro": true,
"datePublish": "2026-05-29T11:47:37+03:00",
"categoryId": [],
"hasSocnetAll": false,
"hasTags": false,
"hasImages": false,
"hasProps": false
},
{
"id": 215,
"blogId": 1,
"publishStatus": "P",
"title": "Опрос",
"detailText": "Текст опроса",
"authorId": 1,
"enableComments": true,
"numComments": "3",
"code": null,
"micro": true,
"datePublish": "2025-08-13T10:46:10+03:00",
"categoryId": [5, 7, 9],
"hasSocnetAll": true,
"hasTags": true,
"hasImages": false,
"hasProps": true
}
],
"meta": {
"total": 89,
"pageSize": 50,
"returned": 3,
"requestedLimit": 3,
"nextOffset": 50
}
}
Пример ответа при ошибке
400 — limit вне диапазона от 1 до 200:
{
"success": false,
"error": {
"code": "INVALID_LIMIT",
"message": "`limit` must be between 1 and 200. The feed is fetched in fixed pages of 50 from Bitrix24; up to 200 records are stitched per request — paginate further via the returned `meta.nextOffset`."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 400 | INVALID_LIMIT |
limit не положительное целое или больше 200 |
| 400 | INVALID_OFFSET |
offset отрицательный или не целое число |
| 401 | TOKEN_MISSING |
У API-ключа не настроены токены доступа |
| 403 | SCOPE_DENIED |
У API-ключа нет скоупа log |
| 422 | BITRIX_ERROR |
Битрикс24 вернул ошибку при выборке постов |
| 502 | BITRIX_UNAVAILABLE |
Битрикс24 недоступен |
Полный список общих ошибок API — Ошибки.
Известные особенности
numCommentsприходит строкой. Количество комментариев представлено строкой ("2"), а не числом — приведите его к числу на стороне клиента, если нужны вычисления.categoryId— всегда массив чисел. Поле содержит список ID категорий/тегов поста:[], если категорий нет,[11]— одна категория,[5, 7, 9]— несколько. Тип единый независимо от количества категорий (не число и не строка).hasPropsможет прийтиnull, а не толькоtrueилиfalse. У поста без свойств, созданного через API,hasPropsприходитnull. Клиент, который проверяет наличие свойств строгим сравнением сtrueилиfalse, должен учитывать и значениеnull. ПоляhasTagsиhasImagesна проверенных постах возвращаютtrueилиfalse.