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 object.
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
// 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
type CommentFile = {
id: number
date: ISODate
type: string
name: string
size: number
image?: { width: number; height: number }
authorId: number
authorName: string
urlPreview: string
urlShow: string
urlDownload: string
}
// Shape of each CommentItem returned in result[]
type CommentItem = {
ID: string
ENTITY_ID: string
ENTITY_TYPE: string
CREATED: ISODate | null
COMMENT: string
AUTHOR_ID: string
FILES: Record<string, CommentFile>
}
try {
// crm.timeline.comment.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<CommentItem[]>({
method: 'crm.timeline.comment.list',
params: {
filter: {
ENTITY_ID: 10,
ENTITY_TYPE: 'deal',
},
select: [
'ID',
'CREATED',
'ENTITY_ID',
'ENTITY_TYPE',
'AUTHOR_ID',
'COMMENT',
'FILES',
],
start: 0,
},
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('Comments count:', result.length, 'first comment:', result[0])
}
} 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 fetchTimelineComments() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.timeline.comment.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.timeline.comment.list',
params: {
filter: {
ENTITY_ID: 10,
ENTITY_TYPE: 'deal',
},
select: [
'ID',
'CREATED',
'ENTITY_ID',
'ENTITY_TYPE',
'AUTHOR_ID',
'COMMENT',
'FILES',
],
start: 0,
},
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('Comments count:', result.length, 'first comment:', result[0])
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchTimelineComments)
</script>
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();
}
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.timeline.comment.list(
filter={
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
select=[
"ID",
"CREATED",
"ENTITY_ID",
"ENTITY_TYPE",
"AUTHOR_ID",
"COMMENT",
"FILES",
],
).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}")
Example as_list
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.timeline.comment.list(
filter={
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
select=[
"ID",
"CREATED",
"ENTITY_ID",
"ENTITY_TYPE",
"AUTHOR_ID",
"COMMENT",
"FILES",
],
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
Example as_list_fast
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.timeline.comment.list(
filter={
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
select=[
"ID",
"CREATED",
"ENTITY_ID",
"ENTITY_TYPE",
"AUTHOR_ID",
"COMMENT",
"FILES",
],
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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}")
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+03:00",
"COMMENT": "New comment was added",
"AUTHOR_ID": "1",
"FILES": {
"1": {
"id": 1,
"date": "2020-03-02T12:00:00+03:00",
"type": "image",
"name": "1.gif",
"size": 43,
"image": {
"width": 1,
"height": 1
},
"authorId": 1,
"authorName": "John Dou",
"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+03:00",
"type": "image",
"name": "2.gif",
"size": 43,
"image": {
"width": 1,
"height": 1
},
"authorId": 1,
"authorName": "John Dou",
"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+03: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+03:00",
"date_finish": "2024-05-03T17:19:01+03: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 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 |
Error message |
Description |
|
Empty string |
Access denied |
No permissions for the specified CRM object |
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 |