Get the Email Thread v 3.0 crm.activity.mail.getThread
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: a user with permission to view the email
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The crm.activity.mail.getThread method returns the CRM email thread that includes the specified email: all emails of the conversation in ascending order of time, up to 200 emails. The response does not contain the email text; it is returned by the crm.activity.mail.getContent method.
Thread emails you cannot view are returned with isHidden: true and without email data.
The method name is written with a capital T: crm.activity.mail.getThread. If the name is written in lowercase, the method returns the "Method Not Found" error.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
activityId* |
ID of any email in the thread, an activity with The ID can be retrieved with the crm.<type>.activity.list method |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.activity.mail.getThread
The examples retrieve the thread of the email with the ID 747.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"activityId":747}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.mail.getThread
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"activityId":747,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.activity.mail.getThread
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type MailThreadResult = {
messages: Array<{
id: number
subject?: string
from?: string
isHidden: boolean
}>
isTruncated: boolean
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<MailThreadResult>(
'crm.activity.mail.getThread',
{
activityId: 747,
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Thread:', result.messages)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getMailThread() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.activity.mail.getThread',
{
activityId: 747,
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Thread:', result.messages)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getMailThread)
</script>
b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.activity.mail.getThread"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"activityId": 747,
},
prefer_version=3,
)
result = response["result"]
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'crm.activity.mail.getThread',
[
'activityId' => 747,
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'crm.activity.mail.getThread',
{
activityId: 747,
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'crm.activity.mail.getThread',
[
'activityId' => 747,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.activity.mail.getThread", b24.Params{
"activityId": 747,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.activity.mail.getThread: %w", err)
}
var result struct {
Messages []struct {
ID int `json:"id"`
Subject string `json:"subject"`
From string `json:"from"`
IsHidden bool `json:"isHidden"`
} `json:"messages"`
IsTruncated bool `json:"isTruncated"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, message := range result.Messages {
fmt.Println(message.ID, message.Subject, message.IsHidden)
}
Response Handling
HTTP status: 200
{
"result": {
"messages": [
{
"id": 747,
"subject": "Commercial proposal",
"dateTime": "2026-10-28T12:19:18+03:00",
"isIncoming": true,
"from": "client@example.com",
"to": [
"sales@example.com"
],
"cc": [],
"bcc": [],
"isHidden": false
}
],
"isTruncated": false
},
"time": {
"start": 1793711360,
"finish": 1793711360.764732,
"duration": 0.7647318840026855,
"processing": 0,
"date_start": "2026-11-03T16:09:20+03:00",
"date_finish": "2026-11-03T16:09:20+03:00",
"operating_reset_at": 1793711940,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Thread data |
|
result.messages |
Thread emails in ascending order of time. Email description |
|
result.isTruncated |
|
|
time |
Information about the request execution time |
Thread Email
|
Name |
Description |
|
id |
Email ID. For a hidden email, |
|
subject |
Email subject. Absent for a hidden email |
|
dateTime |
Email date and time. Absent for a hidden email |
|
isIncoming |
|
|
from |
Sender address. Absent for a hidden email |
|
to |
Recipient addresses. Absent for a hidden email |
|
cc |
CC addresses. For a hidden email, |
|
bcc |
BCC addresses. For a hidden email, |
|
isHidden |
|
Error Handling
HTTP status: 404
{
"error": {
"code": "CRM_EMAIL_ACTIVITY_NOT_FOUND",
"message": "CRM email activity not found."
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Errors
|
Code |
Error description |
How to Fix |
|
|
activityId must be a positive integer. |
Pass |
|
|
This request requires data type |
Pass |
Email Not Found
|
Code |
Error description |
How to Fix |
|
|
CRM email activity not found. |
The email does not exist, or the activity with this ID is not an email. HTTP status: 404 |
|
|
Access denied to the CRM email activity. |
You have no permission to view the email: you have no access to the CRM items it is bound to. HTTP status: 403 |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |