Get a List of Comments from crm.timeline.comment.list
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: a user with read access to CRM entities
The method crm.timeline.comment.list retrieves a list of all comments associated with a specified CRM entity.
Method Parameters
|
Name |
Description |
|
select |
An array of fields to be selected. Pass the fields of the result object. If not provided or an empty array is passed, all fields will be returned. |
|
filter* |
An object for filtering the selected comments in the format The filter works on two mandatory fields:
|
|
order |
An object for sorting the selected comments in the format Only the fields Possible values for
|
|
start |
This parameter is used for managing pagination. The page size for results is always static: 50 records. If the parameter is not provided, the default value To select the second page of results, you need to pass the value The formula for calculating the
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"ENTITY_ID":10,"ENTITY_TYPE":"deal"},"select":["ID","CREATED","ENTITY_ID","ENTITY_TYPE","AUTHOR_ID","COMMENT","FILES"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.comment.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"ENTITY_ID":10,"ENTITY_TYPE":"deal"},"select":["ID","CREATED","ENTITY_ID","ENTITY_TYPE","AUTHOR_ID","COMMENT","FILES"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.comment.list
// callListMethod: Retrieves all data at once. Use only for small datasets (< 1000 items) due to high memory load.
try {
const response = await $b24.callListMethod(
'crm.timeline.comment.list',
{
filter: {
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
select: [
"ID",
"CREATED",
"ENTITY_ID",
"ENTITY_TYPE",
"AUTHOR_ID",
"COMMENT",
"FILES",
],
},
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Retrieves data in chunks using an iterator. Use for large datasets for efficient memory consumption.
try {
const generator = $b24.fetchListMethod('crm.timeline.comment.list', {
filter: {
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
select: [
"ID",
"CREATED",
"ENTITY_ID",
"ENTITY_TYPE",
"AUTHOR_ID",
"COMMENT",
"FILES",
],
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Manual control of pagination through the start parameter. Use for precise control over request batches. Less efficient for large data than fetchListMethod.
try {
const response = await $b24.callMethod('crm.timeline.comment.list', {
filter: {
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
select: [
"ID",
"CREATED",
"ENTITY_ID",
"ENTITY_TYPE",
"AUTHOR_ID",
"COMMENT",
"FILES",
],
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
try {
$response = $b24Service
->core
->call(
'crm.timeline.comment.list',
[
'filter' => [
'ENTITY_ID' => 10,
'ENTITY_TYPE' => 'deal',
],
'select' => [
'ID',
'CREATED',
'ENTITY_ID',
'ENTITY_TYPE',
'AUTHOR_ID',
'COMMENT',
'FILES',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching timeline comments: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.comment.list",
{
filter: {
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
select: [
"ID",
"CREATED",
"ENTITY_ID",
"ENTITY_TYPE",
"AUTHOR_ID",
"COMMENT",
"FILES",
],
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.timeline.comment.list',
[
'filter' => [
'ENTITY_ID' => 10,
'ENTITY_TYPE' => 'deal',
],
'select' => [
'ID',
'CREATED',
'ENTITY_ID',
'ENTITY_TYPE',
'AUTHOR_ID',
'COMMENT',
'FILES',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": [
{
"ID": "999",
"ENTITY_ID": "2",
"ENTITY_TYPE": "deal",
"CREATED": "2020-03-02T12:00:00+02:00",
"COMMENT": "New comment was added",
"AUTHOR_ID": "1",
"FILES": {
"1": {
"id": 1,
"date": "2020-03-02T12:00:00+02:00",
"type": "image",
"name": "1.gif",
"size": 43,
"image": {
"width": 1,
"height": 1
},
"authorId": 1,
"authorName": "John Doe",
"urlPreview": "https://my.bitrix24.com/disk/showFile/930/?&ncc=1&width=640&height=640&signature=292f450929833cd881070155e05a2c41b5bb265ea8c8c1bc2108dbcbb56f667f&ts=1718366521&filename=1.gif",
"urlShow": "https://my.bitrix24.com/disk/showFile/930/?&ncc=1&ts=1718366521&filename=1.gif",
"urlDownload": "https://my.bitrix24.com/disk/downloadFile/930/?&ncc=1&filename=1.gif"
},
"2": {
"id": 2,
"date": "2020-03-02T12:00:00+02:00",
"type": "image",
"name": "2.gif",
"size": 43,
"image": {
"width": 1,
"height": 1
},
"authorId": 1,
"authorName": "John Doe",
"urlPreview": "https://my.bitrix24.com/disk/showFile/931/?&ncc=1&width=640&height=640&signature=118de010a40eff06fb9d691ee9235e2ef809a17780e46927bf8b12f8dc3224db&ts=1718366521&filename=2.gif",
"urlShow": "https://my.bitrix24.com/disk/showFile/931/?&ncc=1&ts=1718366521&filename=2.gif",
"urlDownload": "https://my.bitrix24.com/disk/downloadFile/931/?&ncc=1&filename=2.gif"
}
}
},
{
"ID": "1000",
"ENTITY_ID": "2",
"ENTITY_TYPE": "deal",
"CREATED": "2020-03-02T12:00:00+02:00",
"COMMENT": "Test comment",
"AUTHOR_ID": "1",
"FILES": {}
}
],
"total": 2,
"time": {
"start": 1715091541.642592,
"finish": 1715091541.730599,
"duration": 0.08800697326660156,
"date_start": "2024-05-03T17:19:01+02:00",
"date_finish": "2024-05-03T17:19:01+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response containing an array of objects with information about the selected comments |
|
total |
The total number of records found |
|
time |
Information about the execution time of the request |
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 |
Error Message |
Description |
|
Empty string |
Access denied |
No permissions for the specified CRM entity |
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 |
Continue Learning
- Add Comment crm.timeline.comment.add
- Update Comment crm.timeline.comment.update
- Get Information About the Comment crm.timeline.comment.get
- Delete Comment crm.timeline.comment.delete
- Get Fields of crm.timeline.comment.fields