Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-emails/get.md индекс документации — /llms.txt
Получить содержимое письма CRM
GET /v1/crm-emails/:activityId
Читает текст письма CRM и его связи с записями. Используйте идентификатор дела электронной почты из списка писем.
Доступность: в облаке метод доступен. Для коробочной установки требуется обновление CRM
crm 26.800.1. Без него API вернёт422 METHOD_NOT_YET_AVAILABLEс требуемым выпуском вerror.release.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрactivityId (path) |
Типinteger | Обяз.да | ОписаниеИдентификатор дела из списка писем, а не сообщения модуля почты. |
Примеры
curl — личный ключ
curl -X GET "https://vibecode.bitrix24.tech/v1/crm-emails/1203" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl -X GET "https://vibecode.bitrix24.tech/v1/crm-emails/1203" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const response = await fetch('https://vibecode.bitrix24.tech/v1/crm-emails/1203', {
method: 'GET',
headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()
JavaScript — OAuth-приложение
const response = await fetch('https://vibecode.bitrix24.tech/v1/crm-emails/1203', {
method: 'GET',
headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | Описаниеtrue при успехе. |
Полеdata.id |
Типinteger | ОписаниеИдентификатор. |
Полеdata.subject |
Типstring | ОписаниеТема письма. |
Полеdata.dateTime |
Типstring/null | ОписаниеДата и время или null. |
Полеdata.isIncoming |
Типboolean | ОписаниеВходящее письмо. |
Полеdata.from |
Типstring | ОписаниеОтправитель. |
Полеdata.to |
Типstring[] | ОписаниеОсновные получатели. |
Полеdata.cc |
Типstring[] | ОписаниеПолучатели копии. |
Полеdata.bcc |
Типstring[] | ОписаниеПолучатели скрытой копии. |
Полеdata.body |
Типstring | ОписаниеТекст письма без HTML. |
Полеdata.isBodyTruncated |
Типboolean | ОписаниеТекст усечён на стороне Битрикс24. |
Полеdata.bindings[].entityTypeId |
Типinteger | ОписаниеТип связанной записи CRM. |
Полеdata.bindings[].entityId |
Типinteger | ОписаниеИдентификатор связанной записи CRM. |
Пример ответа
Пример структуры с нейтральными данными.
{
"success": true,
"data": {
"id": 1203,
"subject": "Integration request",
"dateTime": "2026-10-30T10:00:00+00:00",
"isIncoming": true,
"from": "sender@example.com",
"to": [
"reader@example.com"
],
"cc": [],
"bcc": [],
"body": "Hello",
"isBodyTruncated": false,
"bindings": [
{
"entityTypeId": 2,
"entityId": 741
}
]
}
}
Пример ответа при ошибке
400 — неизвестный параметр:
{
"success": false,
"error": {
"code": "UNKNOWN_FILTER_FIELD",
"message": "Unknown query parameter"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеНекорректный тип или идентификатор. |
| HTTP400 | КодUNKNOWN_FILTER_FIELD |
ОписаниеНеизвестный параметр запроса. |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеНет доступа к Битрикс24 у ключа. |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеНужен скоуп crm. |
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеЗапись отсутствует или недоступна. |
| HTTP404 | КодCRM_EMAIL_ACTIVITY_NOT_FOUND |
ОписаниеДело электронной почты не найдено. |
| HTTP422 | КодMETHOD_NOT_YET_AVAILABLE |
ОписаниеНа портале нет метода. Требуемый выпуск указан в error.release. |
| HTTP502 | КодBITRIX_UNAVAILABLE |
ОписаниеОтвет Битрикс24 недоступен или имеет некорректную структуру. |
Другие отказы Битрикс24 сохраняют исходные код и текст. Общие ошибки API.
Известные особенности
Это письма дел CRM. Модуль почты работает с другими идентификаторами сообщений.