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

`POST /v1/timelines/search`

Поиск комментариев таймлайна с фильтром через тело запроса — единый интерфейс с остальными сущностями. Фильтр по `entityType` и `entityId` обязателен: без них запрос возвращает `400 MISSING_REQUIRED_FILTER`. Для простой выборки в контексте одной записи подойдёт и [`GET /v1/timelines`](/docs/entities/timelines/list) с фильтром в параметрах запроса.

## Поля запроса (body)

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

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/timelines/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityType": "deal", "entityId": 575 },
    "select": ["id", "comment", "authorId"],
    "limit": 3
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/timelines/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityType": "deal", "entityId": 575 },
    "select": ["id", "comment", "authorId"],
    "limit": 3
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/timelines/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityType: 'deal', entityId: 575 },
    select: ['id', 'comment', 'authorId'],
    limit: 3,
  }),
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/timelines/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityType: 'deal', entityId: 575 },
    select: ['id', 'comment', 'authorId'],
    limit: 3,
  }),
})

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

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив комментариев (все поля — см. [Поля комментария](/docs/entities/timelines/fields)) |
| `meta.total` | number | Сколько записей подошло под фильтр |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |
| `meta.durationMs` | number | Длительность запроса в миллисекундах |

Поля `meta` лежат рядом с `data`, а не внутри него. Обходить страницы нужно по `meta.hasMore`: длина `data`, равная `limit`, последней страницы не исключает.

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

В запросе передан `select`, поэтому в ответе только выбранные поля.

```json
{
  "success": true,
  "data": [
    {
      "id": 67119,
      "comment": "Первый контакт: клиент заинтересовался предложением",
      "authorId": 1
    },
    {
      "id": 67121,
      "comment": "Уточнение: клиент готов подписать договор на следующей неделе",
      "authorId": 1
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "durationMs": 1208
  }
}
```

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

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

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "POST /v1/timelines/search requires filter fields: entityType, entityId. Example body: { \"filter\": {\"entityType\":\"...\",\"entityId\":\"...\"} }"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_FILTER` | Не переданы обязательные `filter.entityType` и `filter.entityId` |
| 422 | `BITRIX_ERROR` | Неверное значение `entityType` (например, числовой код CRM вместо строки) |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 429 | `RATE_LIMITED` | Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке `x-ratelimit-limit` (потолок делится на реплики). Повторите после срока из заголовка `Retry-After` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

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

**Порядок результатов — по возрастанию `id`.** Список возвращается в порядке создания: самые ранние комментарии первыми. Параметры сортировки (`order`, `sort`) для этого эндпоинта не применяются.

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

- [Список комментариев](/docs/entities/timelines/list)
- [Получить комментарий](/docs/entities/timelines/get)
- [Поля комментария](/docs/entities/timelines/fields)
- [Синтаксис фильтрации](/docs/filtering)
- [Batch](/docs/batch)
- [Лимиты и оптимизация](/docs/optimization)