Get a Set of Additional Content Blocks of the activity crm.activity.layout.blocks.get
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: any user with permission to read the CRM entity to which the activity is linked
The method crm.activity.layout.blocks.get retrieves the set of additional content blocks of an activity.
The method only works in the context of the application: when called via a webhook, it returns the ERROR_WRONG_CONTEXT error. The application sees only the set of blocks that it installed itself using the crm.activity.layout.blocks.set method.
The method works only with activities. To retrieve the set of blocks of a comment or another timeline entry, use crm.timeline.layout.blocks.get.
If the activity is linked to several CRM entities at once, the set of blocks remains a single one. Pass the type and the identifier of any of the linked entities in entityTypeId and entityId.
The order in which the methods are called and the general rules for working with block sets are described in the section overview.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the CRM object type to which the activity is linked, for example |
|
entityId* |
Identifier of the CRM object to which the activity is linked, for example the deal identifier |
|
activityId* |
Identifier of the activity. It is returned by the crm.activity.add and crm.activity.list methods |
Code Examples
Get the set of additional content blocks of the activity with id = 8, linked to the deal with id = 4.
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"activityId":8,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.layout.blocks.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type LayoutBlocksGetResult = {
// layout is null when the app has not set any blocks for this activity
layout: null | {
blocks: Record<string, {
type: string
properties: Record<string, unknown>
}>
}
}
try {
const response = await $b24.actions.v2.call.make<LayoutBlocksGetResult>({
method: 'crm.activity.layout.blocks.get',
params: {
entityTypeId: 2,
entityId: 4,
activityId: 8,
},
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('Layout blocks:', result.layout?.blocks)
}
} 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 getLayoutBlocks() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.layout.blocks.get',
params: {
entityTypeId: 2,
entityId: 4,
activityId: 8,
},
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
// layout is null when the app has not set any blocks for this activity
console.info('Layout blocks:', result.layout?.blocks)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getLayoutBlocks)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.layout.blocks.get(
entity_type_id=2,
entity_id=4,
activity_id=8,
).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}")
try {
$response = $b24Service
->core
->call(
'crm.activity.layout.blocks.get',
[
'entityTypeId' => 2,
'entityId' => 4,
'activityId' => 8,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Info: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting activity layout blocks: ' . $e->getMessage();
}
BX24.callMethod(
'crm.activity.layout.blocks.get',
{
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
activityId: 8, // ID of the activity linked to this deal
},
(result) => {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
},
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.layout.blocks.get',
[
'entityTypeId' => 2,
'entityId' => 4,
'activityId' => 8
]
);
echo '';
print_r($result);
echo '';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.activity.layout.blocks.get", b24.Params{
"entityTypeId": 2,
"entityId": 4,
"activityId": 8,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.activity.layout.blocks.get: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
Response Handling
HTTP status: 200
{
"result": {
"layout": {
"blocks": {
"block_1": {
"type": "text",
"properties": {
"value": "Hello!\nWe are starting.",
"multiline": true,
"bold": true,
"color": "base_90"
}
},
"block_2": {
"type": "largeText",
"properties": {
"value": "Hello!\nWe are starting.\nWe are continuing.\nWe are still working on this.\nWe are continuing.\nWe are close to the result.\nGoodbye."
}
},
"block_3": {
"type": "link",
"properties": {
"text": "Open deal",
"bold": true,
"action": {
"type": "redirect",
"uri": "/crm/deal/details/123/"
}
}
},
"block_4": {
"type": "withTitle",
"properties": {
"title": "Title",
"block": {
"type": "text",
"properties": {
"value": "Some value"
}
}
}
}
}
}
},
"time": {
"start": 1753341040.475739,
"finish": 1753341040.582705,
"duration": 0.10696601867675781,
"processing": 0.04708504676818848,
"date_start": "2025-07-24T17:57:20+00:00",
"date_finish": "2025-07-24T17:57:20+00:00",
"operating": 0
}
}
If no set of blocks is installed:
{
"result": {
"layout": null
},
"time": {
"start": 1753341040.475739,
"finish": 1753341040.582705,
"duration": 0.10696601867675781,
"processing": 0.04708504676818848,
"date_start": "2025-07-24T17:57:20+00:00",
"date_finish": "2025-07-24T17:57:20+00:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response (detailed description). If the set of blocks could not be retrieved, the method returns an |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
layout |
The set of additional content blocks installed in the activity by the current application (detailed description). If the application has not installed a set of blocks in this activity, the field has the value |
Object layout
|
Name |
Description |
|
blocks |
Associative array of content blocks exactly as the application passed them to crm.activity.layout.blocks.set. The key is the block identifier set by the application. The value is an object with the |
The type field takes one of the values text, largeText, link, deadline, withTitle, lineOfBlocks. The composition of properties depends on the block type and is described in the ContentBlockDto structure.
Error Handling
HTTP status: 400
{
"error": "ERROR_WRONG_CONTEXT",
"error_description": "The method can only be called in the context of a rest application"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
The method can only be called in the context of a rest application. The method was called via a webhook |
|
|
The element to which the activity is linked was not found. An unknown |
|
|
The activity with the specified |
|
|
The user has no permission to read the CRM entity to which the activity is linked |
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 |
Continue Learning
- Additional Content Blocks for an Activity: Overview of Methods
- Set a set of additional content blocks in the activity crm.activity.layout.blocks.set
- Delete a set of additional content blocks from the CRM activity crm.activity.layout.blocks.delete
- Configurable Activity Content Block
- Example Application with Additional Content Blocks