Retrieve a Set of Contacts Associated with a Specified Deal crm.deal.contact.items.get
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 permission for deals
The method crm.deal.contact.items.get returns a set of contacts associated with the specified deal.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the deal This can be obtained using the methods crm.deal.list or crm.deal.add |
Code Examples
How to Use Examples in Documentation
Example of retrieving all linked contacts for a deal with id = 1875.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1875}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.contact.items.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1875,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.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 contact binding returned in result[]
type DealContactBinding = {
CONTACT_ID: number
SORT: number
ROLE_ID: number
IS_PRIMARY: string
}
try {
const response = await $b24.actions.v2.call.make<DealContactBinding[]>({
method: 'crm.deal.contact.items.get',
params: {
id: 1875,
},
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('Contacts linked to deal:', 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 getDealContactItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.deal.contact.items.get',
params: {
id: 1875,
},
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('Contacts linked to deal:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDealContactItems)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.deal.contact.items.get(bitrix_id=123).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.deal.contact.items.get',
[
'id' => 1875,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting deal contact items: ' . $e->getMessage();
}
BX24.callMethod(
'crm.deal.contact.items.get',
{
id: 1875,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.deal.contact.items.get',
[
'id' => 1875
]
);
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.deal.contact.items.get", b24.Params{
"id": 1875,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.deal.contact.items.get: %w", err)
}
var items []struct {
ContactID b24.ID `json:"CONTACT_ID"`
Sort int `json:"SORT"`
RoleID b24.ID `json:"ROLE_ID"`
IsPrimary string `json:"IS_PRIMARY"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ContactID, it.Sort)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"CONTACT_ID": 55,
"SORT": 100,
"ROLE_ID": 0,
"IS_PRIMARY": "Y"
},
{
"CONTACT_ID": 54,
"SORT": 200,
"ROLE_ID": 0,
"IS_PRIMARY": "N"
},
{
"CONTACT_ID": 56,
"SORT": 400,
"ROLE_ID": 0,
"IS_PRIMARY": "N"
}
],
"time": {
"start": 1773231773,
"finish": 1773231773.901404,
"duration": 0.9014039039611816,
"processing": 0,
"date_start": "2026-03-11T15:22:53+02:00",
"date_finish": "2026-03-11T15:22:53+02:00",
"operating_reset_at": 1773232373,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains an array with information about contacts linked to the deal |
|
time |
Information about the execution time of the request |
Parameter deal_contact_binding
|
Name |
Description |
|
CONTACT_ID |
Identifier of the contact |
|
SORT |
Sorting index |
|
ROLE_ID |
Role identifier (system field) |
|
IS_PRIMARY |
Indicates whether the binding is primary. Possible values:
|
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Not found."
}
|
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
|
Code |
Description |
Value |
|
Empty value |
|
The provided |
|
Empty value |
|
The user does not have permission to read deals |
|
|
|
No permission to read the deal |
|
Empty value |
|
The deal with the provided |
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 |
|
|
|
The REST API is available only on commercial plans. 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 Contact to Deal crm.deal.contact.add
- Remove Contact from Specified Deal crm.deal.contact.delete
- Get Fields for Deal-Contact Connection crm.deal.contact.fields
- Set a set of contacts associated with the specified deal crm.deal.contact.items.set
- Remove the set of contacts associated with the specified deal crm.deal.contact.items.delete