Список почтовых ящиков — Почта

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

GET /v1/mail/mailboxes

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

#Параметры

Параметр	В	Тип	Обяз.	По умолч.	Описание
`limit`	query	number	нет	`50`	Количество записей на страницу (максимум `500`)
`offset`	query	number	нет	`0`	Смещение от начала списка

#Примеры

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

Terminal

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

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

Terminal

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	Общее количество ящиков на портале
`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: