Get a list of all bindings for the deal crm.activity.binding.list
Scope:
crmWho can execute the method: user with read access permission for CRM entities
The method crm.activity.binding.list retrieves a list of all bindings for the deal.
The method will return an array, where each element will be an array containing:
entityTypeId— integer identifier of the CRM object typeentityId— integer identifier of the CRM entity
The result will only include entities that the current user has read access to.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
activityId* |
Integer identifier of the deal 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 '{"activityId":999}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.binding.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"activityId":999,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.binding.list
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'crm.activity.binding.list',
{
activityId: 999 // Deal ID
}
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const generator = $b24.fetchListMethod('crm.activity.binding.list', { activityId: 999 }, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
try {
const response = await $b24.callMethod('crm.activity.binding.list', { activityId: 999 }, 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.activity.binding.list',
[
'activityId' => 999, // Deal ID
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Result: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'crm.activity.binding.list',
{
activityId: 999 // Deal ID
},
function(result) {
if (result.error()) {
console.error('Error:', result.error());
} else {
console.log('Result:', result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.binding.list',
[
'activityId' => 999 // Deal ID
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result":[
{
"entityTypeId": 1,
"entityId": 123
},
{
"entityTypeId": 2,
"entityId": 456
},
{
"entityTypeId": 3,
"entityId": 789
}
],
"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 |
Result of the operation. Returns an array, where each element will be an array containing:
|
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": "NOT_FOUND",
"error_description": "Element not found"
}
|
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 |
|
|
Required fields not provided |
|
|
Insufficient permissions to perform the operation |
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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". 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 deal binding to a CRM entity crm.activity.binding.add
- Delete the connection of the activity with the CRM entity crm.activity.binding.delete
- Update the deal's connection with the CRM entity crm.activity.binding.move