Retrieve a List of Timeline Record Bindings with CRM Entities crm.timeline.bindings.list
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
Retrieves a list of bindings of a single timeline record with CRM entities.
The list also includes the binding with the entity in which the record was created: it appears automatically, without calling crm.timeline.bindings.bind.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
filter* |
Object for filtering selected records (detailed description) |
|
start |
This parameter is used to manage pagination. The page size of results is always static: 50 bindings. To select the second page of results, pass the value The formula for calculating the
The default value is |
|
order |
The method accepts this parameter but ignores it: sorting of the result is not supported. The value must be an object, otherwise the method returns the error |
Parameter filter
Required parameters are marked with *
|
Name |
Description |
|
OWNER_ID* |
Identifier of the timeline record whose bindings you want to retrieve. Obtain it from the response of the method crm.timeline.comment.add or crm.timeline.logmessage.add, or retrieve it from the list using the method crm.timeline.comment.list or crm.timeline.logmessage.list. The method takes only this filter field into account. Other fields do not affect the result |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"OWNER_ID":999}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.bindings.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"OWNER_ID":999},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.bindings.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each binding returned in result[]
type TimelineBindingItem = {
OWNER_ID: string,
ENTITY_ID: string,
ENTITY_TYPE: string,
}
try {
// The list helpers (callList.make(), fetchList.make()) page through an id cursor field,
// and this method returns no id at all — they would stop after the first page.
// Walk the pages manually: repeat the call with `start` increased by 50 while `next` is present.
const response = await $b24.actions.v2.call.make<TimelineBindingItem[]>({
method: 'crm.timeline.bindings.list',
params: {
filter: {
OWNER_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('Bindings:', result.length, result)
}
} 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@2/dist/umd/index.min.js"></script>
<script>
async function listTimelineBindings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// The list helpers (callList.make(), fetchList.make()) page through an id cursor field,
// and this method returns no id at all — they would stop after the first page.
// Walk the pages manually: repeat the call with `start` increased by 50 while `next` is present.
const response = await $b24.actions.v2.call.make({
method: 'crm.timeline.bindings.list',
params: {
filter: {
OWNER_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('Bindings:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listTimelineBindings)
</script>
Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.timeline.bindings.list(
filter={
"OWNER_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}")
Example as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.timeline.bindings.list(
filter={
"OWNER_ID": 999,
},
).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}")
The fast traversal as_list_fast is not suitable for this method: it pages through the ID field, which is not present in the response.
try {
$response = $b24Service
->core
->call(
'crm.timeline.bindings.list',
[
'filter' => [
'OWNER_ID' => 999,
],
]
);
$result = $response
->getResponseData()
->getResult();
// Retrieve the next page with the same call using the start parameter
print_r($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching timeline bindings: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.bindings.list",
{
filter: {
"OWNER_ID": 999,
},
}, result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
if (result.more()) {
result.next();
}
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.timeline.bindings.list',
[
'filter' => [
'OWNER_ID' => 999,
]
]
);
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.timeline.bindings.list", b24.Params{
"filter": b24.Params{
"OWNER_ID": 999,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.timeline.bindings.list: %w", err)
}
var items []struct {
OwnerID b24.ID `json:"OWNER_ID"`
EntityID b24.ID `json:"ENTITY_ID"`
EntityType string `json:"ENTITY_TYPE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.OwnerID, it.EntityID)
}
// For a full list traversal, use client.Core().Pages: it pages through start.
// Scan does not work here — it goes by identifier, which is not present in the response.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP status: 200
{
"result": [
{
"OWNER_ID": "999",
"ENTITY_ID": "39",
"ENTITY_TYPE": "deal"
},
{
"OWNER_ID": "999",
"ENTITY_ID": "92",
"ENTITY_TYPE": "company"
},
{
"OWNER_ID": "999",
"ENTITY_ID": "205",
"ENTITY_TYPE": "lead"
}
],
"total": 3,
"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
}
}
In the example below, the record has 60 bindings — one binding out of 50 on the first page is shown:
{
"result": [
{
"OWNER_ID": "999",
"ENTITY_ID": "39",
"ENTITY_TYPE": "deal"
}
],
"next": 50,
"total": 60,
"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 |
Array of objects with the bindings found (detailed description) |
|
next |
Value of the |
|
total |
The total number of bindings found |
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
OWNER_ID |
Identifier of the timeline record |
|
ENTITY_ID |
Identifier of the CRM entity |
|
ENTITY_TYPE |
String code of the CRM object type
The response can also contain other CRM object types, for example |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "OWNER_ID is not defined or invalid."
}
|
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
|
Status |
Code |
Description |
Value |
|
|
Empty value |
OWNER_ID is not defined or invalid. |
The required parameter |
|
|
Empty value |
Parameter 'filter' must be array. |
The |
|
|
Empty value |
Parameter 'order' must be array. |
The |
If the timeline record with the given OWNER_ID does not exist or has no bindings, the method returns an empty array in result and total with the value 0.
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
- Add a Timeline Record Binding with a CRM Entity crm.timeline.bindings.bind
- Remove a Timeline Record Binding with a CRM Entity crm.timeline.bindings.unbind
- Retrieve Fields of a Timeline Record Binding with a CRM Entity crm.timeline.bindings.fields
- Timeline Record Bindings with CRM Entities: Overview of Methods