Для 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 присутствует, только когда есть следующая страница. Если его нет, посты закончились.

Общий параметр filter этим эндпоинтом не применяется. По умолчанию API сохраняет прежний ответ HTTP 200 и прежние данные, добавляет заголовок Warning: 299 - "filter is not supported on this endpoint and was ignored", а сервер фиксирует использование неподдерживаемого фильтра в журнале.

Для постов с hasPoll: true передайте ID в GET /v1/polls?postIds=. Подробнее: опросы.

Примеры

curl — личный ключ

Terminal
curl "https://vibecode.bitrix24.tech/v1/posts?limit=3" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal
curl "https://vibecode.bitrix24.tech/v1/posts?limit=3" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

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-приложение

javascript
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 ОписаниеВ посте есть свойства
Полеdata[].hasPoll Типboolean ОписаниеВ посте есть опрос
Полеmeta.total Типnumber ОписаниеОбщее количество постов, доступных ключу
Полеmeta.pageSize Типnumber ОписаниеРазмер страницы Битрикс24 — всегда 50
Полеmeta.returned Типnumber ОписаниеФактическое число постов в ответе
Полеmeta.requestedLimit Типnumber ОписаниеЗначение переданного limit. Присутствует, только если параметр был передан
Полеmeta.nextOffset Типnumber ОписаниеСмещение следующей страницы. Присутствует, только если есть следующая страница — передайте его в offset следующего запроса

Пример ответа

Ответ содержит только перечисленные выше поля — служебные и пользовательские поля Битрикса (UF_*, FILES и т. п.) не отдаются.

JSON
{
  "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,
      "hasPoll": 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,
      "hasPoll": true
    }
  ],
  "meta": {
    "total": 89,
    "pageSize": 50,
    "returned": 3,
    "requestedLimit": 3,
    "nextOffset": 50
  }
}

Пример ответа при ошибке

400 — limit вне диапазона от 1 до 200:

JSON
{
  "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 Код Описание
HTTP200 КодWarning: 299 ОписаниеФильтр игнорируется по умолчанию; прежние данные сохраняются, предупреждение передаётся заголовком Warning.
HTTP400 только при включённом строгом режиме КодUNSUPPORTED_FILTER ОписаниеСерверный режим выключен по умолчанию; до его включения эндпоинт сохраняет HTTP 200 и прежние данные.
HTTP400 КодINVALID_LIMIT Описаниеlimit не положительное целое или больше 200
HTTP400 КодINVALID_OFFSET Описаниеoffset отрицательный или не целое число
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа не настроены токены доступа
HTTP403 КодSCOPE_DENIED ОписаниеУ API-ключа нет скоупа log
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 вернул ошибку при выборке постов
HTTP502 Код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.

Смотрите также