метод REST scope: mail

mail.mailbox.get

Получить почтовый ящик

Кто может выполнять: пользователь с доступом к почтовому ящику

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод mail.mailbox.get возвращает почтовый ящик по идентификатору.

Параметры

id integer обязательный

Идентификатор почтового ящика.

Идентификатор можно получить методом mail.mailbox.list

select array необязательный

Список полей почтового ящика, которые нужно вернуть.

Доступные поля:
- id — идентификатор почтового ящика
- name — имя почтового ящика
- email — электронная почта
- senderName — имя отправителя

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1,"select":["id","name","email","senderName"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.mailbox.get

Ответ

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 1,
            "name": "Рабочая почта",
            "email": "user@example.com",
            "senderName": "Иван Петров"
        }
    },
    "time": {
        "start": 1779819427,
        "finish": 1779819427.356922,
        "duration": 0.356921911239624,
        "processing": 0,
        "date_start": "2026-05-26T21:17:07+03:00",
        "date_finish": "2026-05-26T21:17:07+03:00",
        "operating_reset_at": 1779820027,
        "operating": 0
    }
}

Возвращаемые данные

result object

Объект с данными ответа

item object

Объект почтового ящика. Структура ответа зависит от select

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
        "message": "Запись с ID = `1` не найдена"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
id Обязательное поле id не указано Добавьте id в тело запроса

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.