## Получить цепочку писем CRM

`GET /v1/crm-emails/:activityId/thread`

Читает цепочку переписки для дела электронной почты CRM. Недоступные сообщения обозначаются скрытыми элементами.

> **Доступность:** в облаке метод доступен. Для коробочной установки требуется обновление CRM `crm 26.800.1`. Без него API вернёт `422 METHOD_NOT_YET_AVAILABLE` с требуемым выпуском в `error.release`.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| `activityId` (path) | integer | да | Идентификатор дела из [списка писем](./list.md). |

## Примеры

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

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/crm-emails/1203/thread" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/crm-emails/1203/thread" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/crm-emails/1203/thread', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()
```

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

```javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/crm-emails/1203/thread', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
```

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

| Поле | Описание |
|---|---|
| `data.messages[].id` | Идентификатор. |
| `data.messages[].subject` | Тема письма. |
| `data.messages[].dateTime` | Дата и время или `null`. |
| `data.messages[].isIncoming` | Входящее письмо. |
| `data.messages[].from` | Отправитель. |
| `data.messages[].to` | Основные получатели. |
| `data.messages[].cc` | Получатели копии. У скрытого сообщения — `null`. |
| `data.messages[].bcc` | Получатели скрытой копии. У скрытого сообщения — `null`. |
| `data.messages[].isHidden` | Сообщение скрыто. Тогда доступны только `id:0`, `cc:null`, `bcc:null`, `isHidden:true`. |
| `data.isTruncated` | Цепочка усечена на стороне Битрикс24. |

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

Пример структуры с нейтральными данными.

```json
{
  "success": true,
  "data": {
    "messages": [
      {
        "id": 1203,
        "subject": "Integration request",
        "dateTime": "2026-10-30T10:00:00+00:00",
        "isIncoming": true,
        "from": "sender@example.com",
        "to": [
          "reader@example.com"
        ],
        "cc": [],
        "bcc": [],
        "isHidden": false
      },
      {
        "id": 0,
        "cc": null,
        "bcc": null,
        "isHidden": true
      }
    ],
    "isTruncated": false
  }
}
```

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

400 — неизвестный параметр:

```json
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown query parameter"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|---|---|---|
| 400 | `INVALID_PARAMS` | Некорректный тип или идентификатор. |
| 400 | `UNKNOWN_FILTER_FIELD` | Неизвестный параметр запроса. |
| 401 | `TOKEN_MISSING` | Нет доступа к Битрикс24 у ключа. |
| 403 | `SCOPE_DENIED` | Нужен скоуп `crm`. |
| 404 | `ENTITY_NOT_FOUND` | Запись отсутствует или недоступна. |
| 404 | `CRM_EMAIL_ACTIVITY_NOT_FOUND` | Дело электронной почты не найдено. |
| 422 | `METHOD_NOT_YET_AVAILABLE` | На портале нет метода. Требуемый выпуск указан в `error.release`. |
| 502 | `BITRIX_UNAVAILABLE` | Ответ Битрикс24 недоступен или имеет некорректную структуру. |

Другие отказы Битрикс24 сохраняют исходные код и текст. Общие [ошибки API](/docs/errors).

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

Это письма дел CRM. [Модуль почты](/docs/mail) работает с другими идентификаторами сообщений.

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

- [Настройки CRM](/docs/entities/crm-settings)
- [Письма CRM](/docs/entities/crm-emails)
