## Список почтовых ящиков

`GET /v1/mail/mailboxes`

Возвращает список почтовых ящиков, подключённых к порталу.

## Параметры

| Параметр | В | Тип | Обяз. | По умолч. | Описание |
|----------|---|-----|:-----:|-----------|----------|
| `limit` | query | number | нет | `50` | Количество записей на страницу. Максимум — `5000`, большее значение усекается до него |
| `offset` | query | number | нет | `0` | Смещение от начала списка |

Когда Битрикс24 не сообщает общее количество ящиков, `meta.total` отсутствует. Продолжайте постраничную загрузку по `meta.hasMore`: полная страница означает, что записи могут продолжаться, а короткая доказывает конец списка.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/mail/mailboxes" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/mail/mailboxes" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/mail/mailboxes', {
  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/mail/mailboxes', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data, meta } = await res.json()
```

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

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив почтовых ящиков |
| `data[].id` | number | Идентификатор ящика |
| `data[].name` | string | Отображаемое имя ящика |
| `data[].email` | string | Адрес электронной почты ящика |
| `data[].senderName` | string | Имя отправителя, подставляемое в поле «От» |
| `meta.total` | number (optional) | Общее количество ящиков на портале. Поле отсутствует, если Битрикс24 не сообщил количество |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |

URL любого ящика из массива `data` — его `id`:

```
https://<portal>.bitrix24.ru/mail/list/<id>/
```

`<portal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Рабочая почта",
      "email": "info@example.com",
      "senderName": "Компания"
    },
    {
      "id": 2,
      "name": "Поддержка",
      "email": "support@example.com",
      "senderName": "Служба поддержки"
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}
```

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

403 — нет скоупа `mail`:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'mail' scope"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `mail` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 429 | `RATE_LIMITED` | Превышен лимит запросов |
| 502 | `BITRIX_UNAVAILABLE` | Портал Битрикс24 недоступен |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку |

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

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

- Список приходит массивом в `data` с пагинацией в `meta` (`hasMore` и, когда количество известно, `total`); в `GET /v1/mail/messages` письма возвращаются иначе — в `data.items`.

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

- [Получить почтовый ящик](./get.md)
- [Адреса отправителя ящика](./senders.md)