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

GET /v1/mail/mailboxes/:id

Возвращает данные одного почтового ящика по его идентификатору.

#Параметры

Параметр В Тип Обяз. По умолч. Описание
id path number да — Идентификатор почтового ящика (из списка ящиков)

#Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/mail/mailboxes/1" \
  -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/1', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()
console.log(data.email)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/mail/mailboxes/1', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор ящика
data.name string Отображаемое имя ящика
data.email string Адрес электронной почты ящика
data.senderName string Имя отправителя, подставляемое в поле «От»

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

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "name": "Рабочая почта",
    "email": "info@example.com",
    "senderName": "Компания"
  }
}

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

404 — ящик не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `42` не найдена"
  }
}

#Ошибки

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

Полный список общих ошибок API — Ошибки.

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

Нечисловой ID. Нечисловые значения вроде abc уходят в Битрикс24 с id=0 и возвращают 404 ENTITY_NOT_FOUND, а не ошибку валидации.

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