Get information about the activity by ID crm.activity.get
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
crmWho can execute the method: any user
The method crm.activity.get returns information about the activity by its ID.
Method parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
The ID of the activity in the timeline, for example |
Code examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{ "id":999 }' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ActivityGetResult = {
ID: string
OWNER_ID: string
OWNER_TYPE_ID: string
TYPE_ID: string
PROVIDER_ID: string
PROVIDER_TYPE_ID: string
PROVIDER_GROUP_ID: string | null
ASSOCIATED_ENTITY_ID: string
SUBJECT: string
CREATED: ISODate
LAST_UPDATED: ISODate
START_TIME: ISODate
END_TIME: ISODate
DEADLINE: ISODate
COMPLETED: string
STATUS: string
RESPONSIBLE_ID: string
PRIORITY: string
NOTIFY_TYPE: string
NOTIFY_VALUE: string
DESCRIPTION: string
DESCRIPTION_TYPE: string
DIRECTION: string
LOCATION: string
SETTINGS: unknown[]
ORIGINATOR_ID: string | null
ORIGIN_ID: string | null
AUTHOR_ID: string
EDITOR_ID: string
PROVIDER_PARAMS: unknown[]
PROVIDER_DATA: string | null
RESULT_MARK: string
RESULT_VALUE: unknown | null
RESULT_SUM: unknown | null
RESULT_CURRENCY_ID: string | null
RESULT_STATUS: string
RESULT_STREAM: string
RESULT_SOURCE_ID: string | null
AUTOCOMPLETE_RULE: string
}
try {
const response = await $b24.actions.v2.call.make<ActivityGetResult>({
method: 'crm.activity.get',
params: {
id: 999,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Activity:', result.ID, result.SUBJECT, result.STATUS)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getActivity() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.get',
params: {
id: 999,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Activity:', result.ID, result.SUBJECT, result.STATUS)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getActivity)
</script>
try {
$response = $b24Service
->core
->call(
'crm.activity.get',
[
'id' => 999,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting activity: ' . $e->getMessage();
}
BX24.callMethod(
'crm.activity.get',
{
id: 999,
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.get',
[
'id' => 999
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.activity.get(
bitrix_id=999,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
Response handling
HTTP status: 200
{
"result": {
"ID": "999",
"OWNER_ID": "15",
"OWNER_TYPE_ID": "3",
"TYPE_ID": "2",
"PROVIDER_ID": "VOXIMPLANT_CALL",
"PROVIDER_TYPE_ID": "CALL",
"PROVIDER_GROUP_ID": null,
"ASSOCIATED_ENTITY_ID": "0",
"SUBJECT": "Outgoing call Andrew Johnson",
"CREATED": "2020-09-27T13:26:55+02:00",
"LAST_UPDATED": "2021-03-21T20:28:24+02:00",
"START_TIME": "2020-09-27T13:25:00+02:00",
"END_TIME": "2020-09-27T19:25:00+02:00",
"DEADLINE": "2020-09-27T13:25:00+02:00",
"COMPLETED": "Y",
"STATUS": "2",
"RESPONSIBLE_ID": "505",
"PRIORITY": "2",
"NOTIFY_TYPE": "1",
"NOTIFY_VALUE": "15",
"DESCRIPTION": "",
"DESCRIPTION_TYPE": "1",
"DIRECTION": "2",
"LOCATION": "",
"SETTINGS": [],
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"AUTHOR_ID": "505",
"EDITOR_ID": "505",
"PROVIDER_PARAMS": [],
"PROVIDER_DATA": null,
"RESULT_MARK": "0",
"RESULT_VALUE": null,
"RESULT_SUM": null,
"RESULT_CURRENCY_ID": null,
"RESULT_STATUS": "0",
"RESULT_STREAM": "0",
"RESULT_SOURCE_ID": null,
"AUTOCOMPLETE_RULE": "0"
},
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Returned data
|
Name |
Description |
|
result |
Root element of the response. Values for the |
|
time |
Information about the request execution time |
Error handling
HTTP status: 400
{
"error": "",
"error_description": "Access denied."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible error codes
|
Code |
Description |
|
|
The activity with the specified ID was not found for the entity in CRM |
|
|
No rights to edit the entity in CRM |
|
|
Invalid |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |