#Список комментариев

GET /v1/timelines

Возвращает комментарии таймлайна, привязанные к конкретной записи CRM. Фильтр по entityType и entityId обязателен — без них запрос возвращает 400 MISSING_REQUIRED_FILTER.

#Параметры

Параметр Тип Обяз. По умолч. Описание
filter[entityType] string да — Тип родительской записи CRM: deal, lead, contact, company или DYNAMIC_<entityTypeId> для смарт-процессов (например, DYNAMIC_174)
filter[entityId] number да — ID родительской записи. Источник зависит от типа: GET /v1/deals, GET /v1/leads, GET /v1/contacts, GET /v1/companies, GET /v1/items/:entityTypeId (элементы смарт-процессов)
limit number нет 50 Количество записей (до 5000). При limit > 50 Вайбкод автоматически запрашивает несколько страниц у Битрикс24
offset number нет 0 Пропустить N записей. При offset > 0 рекомендуется limit ≤ 500
select string нет — Выборка полей: ?select=id,comment,authorId

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/timelines?filter[entityType]=deal&filter[entityId]=741" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/timelines?filter[entityType]=deal&filter[entityId]=741" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/timelines?filter[entityType]=deal&filter[entityId]=741', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} комментариев`)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/timelines?filter[entityType]=deal&filter[entityId]=741', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив комментариев (все поля — см. Поля комментария)
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 66309,
      "entityId": 741,
      "entityType": "deal",
      "comment": "Первый контакт: клиент заинтересовался предложением",
      "authorId": 1,
      "createdAt": "2026-04-24T12:39:28.000Z"
    },
    {
      "id": 66311,
      "entityId": 741,
      "entityType": "deal",
      "comment": "Уточнение: клиент готов подписать договор на следующей неделе",
      "authorId": 1,
      "createdAt": "2026-04-24T12:39:30.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

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

400 — не передан обязательный фильтр:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "GET /v1/timelines requires filter fields: entityType, entityId. Example: GET /v1/timelines?filter[entityType]=...&filter[entityId]=..."
  }
}

#Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_FILTER Не переданы обязательные filter[entityType] и filter[entityId]
422 BITRIX_ERROR Неверное значение entityType (например, числовой код CRM вместо строки)
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

#Известные особенности

entityType — строка. Используйте строковые идентификаторы CRM-типов: deal, lead, contact, company. Для смарт-процессов — DYNAMIC_<entityTypeId> (например, DYNAMIC_174). В ответе значение приходит в нижнем регистре (dynamic_174). Числовые коды CRM в entityType не работают — возвращается 422 BITRIX_ERROR Access denied..

Фильтрация только по entityType + entityId. Битрикс24 игнорирует любые дополнительные поля в фильтре (authorId, comment, диапазоны >=createdAt и т. п.) — ответ возвращается тот же, что и без них. Если нужен отбор по автору или тексту — получите все комментарии записи и отфильтруйте на стороне клиента.

Порядок результатов — по id ASC. Список возвращается в порядке создания: самые ранние комментарии первыми. Если нужен обратный порядок — переверните массив на клиенте (data.reverse()). Параметры сортировки (order[...], sort=) для этого эндпоинта не применяются.

Авто-пагинация. При limit > 50 Вайбкод автоматически запрашивает несколько страниц у Битрикс24 и возвращает все записи в одном ответе.

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