Get leads, contacts, and companies with matching data crm.duplicate.findbycomm
Scope:
crmWho can execute the method: user with read access permission to CRM entities
The method crm.duplicate.findbycomm returns the identifiers of leads, contacts, and companies that contain phone numbers or email addresses from a specified list. The search does not consider the phone extension.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
type* |
Type of communication. Possible values:
|
|
values* |
Array of emails or phone numbers. Maximum number of values — 20 |
|
entity_type |
Type of object. Possible values:
If not specified — the search is performed across all three types |
Method Operation Features
If 20 or more duplicates are found for one object, the other types are not returned. For example, if entity_type is not specified and duplicates are expected across all three objects, but there are 20 or more duplicates in leads, contacts and companies will not be returned. If there are 20 or more duplicates in contacts, we will receive duplicates for leads and contacts, while the company will be absent from the selection.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entity_type":"CONTACT","type":"PHONE","values":["1234567","11223355"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.duplicate.findbycomm
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**","entity_type":"CONTACT","type":"PHONE","values":["1234567","11223355"]}' \
https://**put_your_bitrix24_address**/rest/crm.duplicate.findbycomm
try
{
const response = await $b24.callMethod(
'crm.duplicate.findbycomm',
{
entity_type: 'CONTACT',
type: 'PHONE',
values: ['1234567', '11223355']
}
);
const result = response.getData().result;
if (result.error()) {
console.error(result.error());
} else {
console.dir(result);
}
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.duplicate.findbycomm',
[
'entity_type' => 'CONTACT',
'type' => 'PHONE',
'values' => ['1234567', '11223355'],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Duplicate data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error finding duplicates by communication: ' . $e->getMessage();
}
BX24.callMethod(
"crm.duplicate.findbycomm",
{
entity_type: "CONTACT",
type: "PHONE",
values: ["1234567", "11223355"]
},
function(result) {
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.duplicate.findbycomm',
[
'entity_type' => 'CONTACT',
'type' => 'PHONE',
'values' => ['1234567', '11223355']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"CONTACT": [275, 2297]
},
"time": {
"start": 1750684060.672785,
"finish": 1750684060.724903,
"duration": 0.05211806297302246,
"processing": 0.018191099166870117,
"date_start": "2025-06-23T16:07:40+02:00",
"date_finish": "2025-06-23T16:07:40+02:00",
"operating_reset_at": 1750684660,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
LEAD |
Array of identifiers of found leads |
|
CONTACT |
Array of identifiers of found contacts |
|
COMPANY |
Array of identifiers of found companies |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": "Communication type is not defined",
"error_description": "Parameter 'type' is required."
}
|
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 |
Value |
|
|
|
User does not have permission to read CRM entities |
|
|
|
Required parameter |
|
|
|
An unsupported communication type was specified |
|
|
|
Required parameter |
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 |