## List CRM e-mails

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

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

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

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

Read one page of e-mails linked to a deal, lead, contact or company. Bitrix24 checks access to the record.

## Parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| `id` (path) | integer | yes | Record identifier from [deals](/docs/entities/deals), [leads](/docs/entities/leads), [contacts](/docs/entities/contacts) or [companies](/docs/entities/companies). |
| `limit` (query) | integer | no | Page size. The effective value is returned in `meta.limit`. |
| `offset` (query) | integer | no | Offset from zero. Continue with `meta.nextOffset`. |
| `isIncoming` (query) | boolean | no | `true` or `1` for incoming, `false` or `0` for outgoing. Omit for both. |

## Examples

### curl — personal key

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

### curl — OAuth application

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

### JavaScript — personal key

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

### JavaScript — OAuth application

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

## Response fields

| Field | Type | Description |
|---|---|---|
| `success` | boolean | `true` on success. |
| `data` | array | E-mails on the page. |
| `data[].id` | integer | Identifier. |
| `data[].subject` | string | E-mail subject. |
| `data[].dateTime` | string/null | Date and time, or `null`. |
| `data[].isIncoming` | boolean | Whether the e-mail is incoming. |
| `data[].from` | string | Sender. |
| `data[].to` | string[] | Primary recipients. |
| `meta.returnedCount` | integer | Number of returned records. |
| `meta.hasMore` | boolean | Whether another page is available. |
| `meta.nextOffset` | integer/null | Next page offset, or `null`. |
| `meta.limit` | integer | Effective page size. |
| `meta.offset` | integer | Effective offset. |

## Response example

Response structure with neutral sample data.

```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
  }
}
```

## Error response example

400 — unknown query parameter:

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

## Errors

| HTTP | Code | Description |
|---|---|---|
| 400 | `INVALID_PARAMS` | Invalid type or identifier. |
| 400 | `UNKNOWN_FILTER_FIELD` | Unknown query parameter. |
| 401 | `TOKEN_MISSING` | The key has no Bitrix24 credentials. |
| 403 | `SCOPE_DENIED` | The `crm` scope is required. |
| 404 | `ENTITY_NOT_FOUND` | The record is absent or inaccessible. |
| 404 | `CRM_EMAIL_ACTIVITY_NOT_FOUND` | The e-mail activity was not found. |
| 422 | `METHOD_NOT_YET_AVAILABLE` | The method is absent on the account. `error.release` names the required release. |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable or returned an invalid response shape. |

Other Bitrix24 refusals retain their original code and message. Common [API errors](/docs/errors).

## Known behavior

These are CRM activity e-mails. The [Mail module](/docs/mail) uses different message identifiers.

Each request reads one page. No collection total is supplied. Continue only by `meta.hasMore` and `meta.nextOffset`. Filtering, sorting and field selection are not supported.

## See also

- [CRM settings](/docs/entities/crm-settings)
- [CRM e-mails](/docs/entities/crm-emails)