Get a List of Related Contacts crm.lead.contact.items.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: a user with the "Read" access permission for the lead
DEPRECATED
The development of this method has been halted. Please use the REST 3.0 method crm.lead.get. The links are returned in the contactsId field, and the primary link in the contactId field.
The method crm.lead.contact.items.get returns the set of contacts linked to the specified lead.
The method returns all bindings of the lead at once: it has no parameters for filtering, field selection, or pagination. To change the set, use crm.lead.contact.items.set, and to add or remove a single contact, use crm.lead.contact.add and crm.lead.contact.delete. The structure of the binding object is described in the section overview.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the lead. Must be greater than The identifier can be retrieved using the method crm.item.list with |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.contact.items.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.contact.items.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 each linked contact returned in result[]
type CrmLeadContactItem = {
CONTACT_ID: number
SORT: number
ROLE_ID: number
IS_PRIMARY: string
}
try {
const response = await $b24.actions.v2.call.make<CrmLeadContactItem[]>({
method: 'crm.lead.contact.items.get',
params: {
id: 1,
},
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('Linked contacts:', 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@1/dist/umd/index.min.js"></script>
<script>
async function getLeadContactItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.lead.contact.items.get',
params: {
id: 1,
},
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('Linked contacts:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getLeadContactItems)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.lead.contact.items.get(
bitrix_id=1,
).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.lead.contact.items.get',
[
'id' => 1,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Data: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting lead contact items: ' . $e->getMessage();
}
BX24.callMethod(
"crm.lead.contact.items.get",
{
id: 1,
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.contact.items.get',
[
'id' => 1
]
);
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.lead.contact.items.get", b24.Params{
"id": 1,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.lead.contact.items.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": [
{
"CONTACT_ID": 1010,
"SORT": 10,
"ROLE_ID": 0,
"IS_PRIMARY": "Y"
},
{
"CONTACT_ID": 1011,
"SORT": 20,
"ROLE_ID": 0,
"IS_PRIMARY": "N"
}
],
"time": {
"start": 1715091541.642592,
"finish": 1715091541.730599,
"duration": 0.08800697326660156,
"date_start": "2024-05-07T17:19:01+02:00",
"date_finish": "2024-05-07T17:19:01+02:00",
"operating": 0
}
}
Response when the lead has no linked contacts:
{
"result": [],
"time": {
"start": 1715091541.642592,
"finish": 1715091541.730599,
"duration": 0.08800697326660156,
"date_start": "2024-05-07T17:19:01+02:00",
"date_finish": "2024-05-07T17:19:01+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains an array with information about the contacts linked to the lead, sorted by The method does not separately check whether the lead exists: if the permission check passes, it returns an empty array rather than an error for a non-existent |
|
time |
Information about the execution time of the request |
lead_contact_binding Object
|
Name |
Description |
|
CONTACT_ID |
Identifier of the linked contact. The contact data can be retrieved using the method crm.item.get with |
|
SORT |
The sorting index |
|
ROLE_ID |
Role identifier. The field is reserved: the link methods do not accept it on write, and new bindings receive |
|
IS_PRIMARY |
Whether this is the lead's primary contact. Possible values:
|
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "The parameter ownerEntityID is invalid or not defined."
}
|
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 |
The parameter ownerEntityID is invalid or not defined. |
The |
|
|
Empty value |
Access denied. |
The user does not have read access to CRM objects, including those in digital workspaces |
|
|
|
Access denied! |
The user does not have permission to read the lead |
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
- Linking Leads to Contacts: Overview of Methods
- Add Contact Binding to Lead crm.lead.contact.add
- Remove contact binding from lead crm.lead.contact.delete
- Attach a list of contacts to a lead crm.lead.contact.items.set
- Delete Contact List from Lead crm.lead.contact.items.delete
- Get Lead-Contact Fields crm.lead.contact.fields