#Получить письмо

GET /v1/mail/messages/:id

Возвращает одно письмо по идентификатору, включая полный текст сообщения.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор письма. Список: GET /v1/mail/messages

#Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/mail/messages/1761" \
  -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/messages/1761', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()
console.log('Тема:', data.item.subject)

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

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.item object Объект письма
data.item.id number Идентификатор письма
data.item.mailboxId number Идентификатор почтового ящика
data.item.mailboxEmail string Адрес почтового ящика
data.item.subject string Тема письма
data.item.from string Отправитель в формате Имя <адрес>
data.item.to string Получатель в формате Имя <адрес>
data.item.cc string Копия письма; пустая строка "" когда копий нет
data.item.date string Дата отправки в формате YYYY-MM-DD HH:MM:SS (без часового пояса)
data.item.isSeen boolean Прочитано ли письмо
data.item.hasAttachments boolean Есть ли вложения
data.item.url string Ссылка на письмо в интерфейсе Битрикс24
data.item.bindings array Привязки письма к объектам CRM
data.item.body string Полный текст письма с переносами строк (\r\n)

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

JSON 
{
  "success": true,
  "data": {
    "item": {
      "id": 1761,
      "mailboxId": 5,
      "mailboxEmail": "support@example.com",
      "subject": "Запрос по интеграции",
      "from": "Поддержка <support@example.com>",
      "to": "anna@example.com <anna@example.com>",
      "cc": "",
      "date": "2026-05-18 15:35:10",
      "isSeen": true,
      "hasAttachments": false,
      "url": "https://example.bitrix24.ru/mail/message/1761",
      "bindings": [],
      "body": "Здравствуйте! Уточните, пожалуйста, сроки по интеграции.\r\n\r\n-- \r\nС уважением, отдел поддержки"
    }
  }
}

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

404 — письмо не найдено:

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

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является положительным целым числом (сообщение: id must be a positive integer)
404 ENTITY_NOT_FOUND Письмо с указанным id не найдено
403 SCOPE_DENIED API-ключ не имеет скоупа mail
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
429 RATE_LIMITED Превышен лимит запросов (заголовок Retry-After: 2)
502 BITRIX_UNAVAILABLE Портал Битрикс24 вернул ошибку 5xx
422 BITRIX_ERROR Прочие ошибки Битрикс24
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный API-ключ
401 KEY_INACTIVE API-ключ деактивирован
401 KEY_EXPIRED Срок действия API-ключа истёк

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

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