## Список писем CRM

`GET /v1/deals/:id/emails`

`GET /v1/leads/:id/emails`

`GET /v1/contacts/:id/emails`

`GET /v1/companies/:id/emails`

Читает одну страницу писем, связанных со сделкой, лидом, контактом или компанией. Права на записи проверяет Битрикс24.

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

## Параметры

| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| `id` (path) | integer | да | Идентификатор записи из [сделок](/docs/entities/deals), [лидов](/docs/entities/leads), [контактов](/docs/entities/contacts) или [компаний](/docs/entities/companies). |
| `limit` (query) | integer | нет | Размер одной страницы. Эффективное значение приходит в `meta.limit`. |
| `offset` (query) | integer | нет | Смещение от нуля. Продолжайте с `meta.nextOffset`. |
| `isIncoming` (query) | boolean | нет | `true` или `1` — входящие, `false` или `0` — исходящие. Без параметра — оба направления. |

## Примеры

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

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

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

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

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

```javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/deals/741/emails', {
  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/deals/741/emails', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
```

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

| Поле | Тип | Описание |
|---|---|---|
| `success` | boolean | `true` при успехе. |
| `data` | array | Письма страницы. |
| `data[].id` | integer | Идентификатор. |
| `data[].subject` | string | Тема письма. |
| `data[].dateTime` | string/null | Дата и время или `null`. |
| `data[].isIncoming` | boolean | Входящее письмо. |
| `data[].from` | string | Отправитель. |
| `data[].to` | string[] | Основные получатели. |
| `meta.returnedCount` | integer | Число записей в ответе. |
| `meta.hasMore` | boolean | Есть следующая страница. |
| `meta.nextOffset` | integer/null | Смещение следующей страницы или `null`. |
| `meta.limit` | integer | Эффективный размер страницы. |
| `meta.offset` | integer | Эффективное смещение. |

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

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

```json
{
  "success": true,
  "data": [
    {
      "id": 1203,
      "subject": "Integration request",
      "dateTime": "2026-10-30T10:00:00+00:00",
      "isIncoming": true,
      "from": "sender@example.com",
      "to": [
        "reader@example.com"
      ]
    }
  ],
  "meta": {
    "returnedCount": 1,
    "hasMore": false,
    "nextOffset": null,
    "limit": 50,
    "offset": 0
  }
}
```

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

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) работает с другими идентификаторами сообщений.

Один запрос читает одну страницу. Общего количества нет. Продолжайте только по `meta.hasMore` и `meta.nextOffset`. Фильтры, сортировка и выбор полей не поддерживаются.

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

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