Get a List of Contacts crm.contact.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 with "read" access permission for contacts
DEPRECATED
The development of this method has been halted. Please use crm.item.list.
The method crm.contact.list returns a list of contacts based on a filter. It is an implementation of the list method for contacts.
To retrieve a list of companies associated with a contact, use the method crm.contact.company.items.get.
Method Parameters
|
Name |
Description |
|
select |
A list of fields that should be populated for the contacts in the selection. You can use masks in the selection:
There is no mask for selecting multiple fields. To select multiple fields, specify the required ones in the selection list ( You can find the list of available fields for selection using the method By default, all fields are taken — |
|
filter |
An object in the format:
where:
You can add a prefix to the keys
The fields Phone ( Additionally, the You can find the list of available fields for filtering using the method The |
|
order |
An object in the format:
where:
You can find the list of available fields for sorting using the method |
|
start |
A parameter for managing pagination. The page size of results is always static — 50 records. To select the second page of results, pass the value The formula for calculating the
|
Also, see the description of list methods.
Code Examples
How to Use Examples in Documentation
Get a list of contacts where:
- the source is CRM Form
- first name and last name are not empty
- first name or last name starts with "I"
- they participate in export
- e-mail equals 'special-for@example.com'
- the responsible ID is either 1 or 6
- created less than 6 months ago
Set the order of the selection: first name and last name in ascending order.
For clarity, select only the necessary fields:
- Contact ID
- First Name
- Last Name
- Participation in export
- Responsible
- Creation Date
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FILTER":{"SOURCE_ID":"CRM_FORM","!=NAME":"","!=LAST_NAME":"","=%NAME":"I%","=%LAST_NAME":"I%","EMAIL":"special-for@example.com","@ASSIGNED_BY_ID":[1,6],"IMPORT":"Y",">=DATE_CREATE":"**put_six_month_ago_date_here**"},"ORDER":{"LAST_NAME":"ASC","NAME":"ASC"},"SELECT":["ID","NAME","LAST_NAME","EMAIL","EXPORT","ASSIGNED_BY_ID","DATE_CREATE"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FILTER":{"SOURCE_ID":"CRM_FORM","!=NAME":"","!=LAST_NAME":"","=%NAME":"I%","=%LAST_NAME":"I%","EMAIL":"special-for@example.com","@ASSIGNED_BY_ID":[1,6],"IMPORT":"Y",">=DATE_CREATE":"**put_six_month_ago_date_here**"},"ORDER":{"LAST_NAME":"ASC","NAME":"ASC"},"SELECT":["ID","NAME","LAST_NAME","EMAIL","EXPORT","ASSIGNED_BY_ID","DATE_CREATE"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.contact.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each contact object returned in result[]
type CrmContactListItem = {
ID: string
NAME: string
LAST_NAME: string
EXPORT: string
ASSIGNED_BY_ID: string
DATE_CREATE: ISODate | null
EMAIL?: CrmContactEmail[]
}
type CrmContactEmail = {
ID: string
VALUE_TYPE: string
VALUE: string
TYPE_ID: string
}
const sixMonthAgo = new Date()
sixMonthAgo.setMonth(new Date().getMonth() - 6)
try {
// crm.contact.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<CrmContactListItem[]>({
method: 'crm.contact.list',
params: {
filter: {
SOURCE_ID: 'CRM_FORM',
'!=NAME': '',
'!=LAST_NAME': '',
'=%NAME': 'J%',
'=%LAST_NAME': 'J%',
EMAIL: 'special-for@example.com',
'@ASSIGNED_BY_ID': [1, 6],
IMPORT: 'Y',
'>=DATE_CREATE': sixMonthAgo.toISOString(),
},
order: {
LAST_NAME: 'ASC',
NAME: 'ASC',
},
select: [
'ID',
'NAME',
'LAST_NAME',
'EMAIL',
'EXPORT',
'ASSIGNED_BY_ID',
'DATE_CREATE',
],
start: 0,
},
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 on this page:', 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 listContacts() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const sixMonthAgo = new Date()
sixMonthAgo.setMonth(new Date().getMonth() - 6)
// crm.contact.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.contact.list',
params: {
filter: {
SOURCE_ID: 'CRM_FORM',
'!=NAME': '',
'!=LAST_NAME': '',
'=%NAME': 'J%',
'=%LAST_NAME': 'J%',
EMAIL: 'special-for@example.com',
'@ASSIGNED_BY_ID': [1, 6],
IMPORT: 'Y',
'>=DATE_CREATE': sixMonthAgo.toISOString(),
},
order: {
LAST_NAME: 'ASC',
NAME: 'ASC',
},
select: [
'ID',
'NAME',
'LAST_NAME',
'EMAIL',
'EXPORT',
'ASSIGNED_BY_ID',
'DATE_CREATE',
],
start: 0,
},
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 on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listContacts)
</script>
try {
$sixMonthAgo = new DateTime();
$sixMonthAgo->setDate((new DateTime())->getMonth() - 6);
$response = $b24Service
->core
->call(
'crm.contact.list',
[
'filter' => [
'SOURCE_ID' => 'CRM_FORM',
'!=NAME' => '',
'!=LAST_NAME' => '',
'=%NAME' => 'I%',
'=%LAST_NAME' => 'I%',
'EMAIL' => 'special-for@example.com',
'@ASSIGNED_BY_ID' => [1, 6],
'IMPORT' => 'Y',
'>=DATE_CREATE' => $sixMonthAgo->format('Y-m-d\TH:i:s'),
],
'order' => [
'LAST_NAME' => 'ASC',
'NAME' => 'ASC',
],
'select' => [
'ID',
'NAME',
'LAST_NAME',
'EMAIL',
'EXPORT',
'ASSIGNED_BY_ID',
'DATE_CREATE',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching contact list: ' . $e->getMessage();
}
const sixMonthAgo = new Date();
sixMonthAgo.setMonth((new Date()).getMonth() - 6);
BX24.callMethod(
'crm.contact.list',
{
filter: {
"SOURCE_ID": "CRM_FORM",
"!=NAME": "",
"!=LAST_NAME": "",
"=%NAME": "I%",
"=%LAST_NAME": "I%",
"EMAIL": "special-for@example.com",
"@ASSIGNED_BY_ID": [1, 6],
"IMPORT": "Y",
">=DATE_CREATE": sixMonthAgo.toISOString(),
},
order: {
LAST_NAME: "ASC",
NAME: "ASC",
},
select: [
"ID",
"NAME",
"LAST_NAME",
"EMAIL",
"EXPORT",
"ASSIGNED_BY_ID",
"DATE_CREATE",
],
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$sixMonthAgo = new DateTime();
$sixMonthAgo->modify('-6 months');
$result = CRest::call(
'crm.contact.list',
[
'FILTER' => [
'SOURCE_ID' => 'CRM_FORM',
'!=NAME' => '',
'!=LAST_NAME' => '',
'=%NAME' => 'I%',
'=%LAST_NAME' => 'I%',
'EMAIL' => 'special-for@example.com',
'@ASSIGNED_BY_ID' => [1, 6],
'IMPORT' => 'Y',
'>=DATE_CREATE' => $sixMonthAgo->format(DateTime::ATOM),
],
'ORDER' => [
'LAST_NAME' => 'ASC',
'NAME' => 'ASC',
],
'SELECT' => [
'ID',
'NAME',
'LAST_NAME',
'EMAIL',
'EXPORT',
'ASSIGNED_BY_ID',
'DATE_CREATE',
]
]
);
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.contact.list", b24.Params{
"filter": b24.Params{
"SOURCE_ID": "CRM_FORM",
"!=NAME": "",
"!=LAST_NAME": "",
"=%NAME": "K%",
"=%LAST_NAME": "W%",
"EMAIL": "special-for@example.com",
"@ASSIGNED_BY_ID": []int{1, 6},
"IMPORT": "Y",
">=DATE_CREATE": "**put_six_month_ago_date_here**",
},
"order": b24.Params{
"LAST_NAME": "ASC",
"NAME": "ASC",
},
"select": []string{"ID", "NAME", "LAST_NAME", "EMAIL", "EXPORT", "ASSIGNED_BY_ID", "DATE_CREATE"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.contact.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Name string `json:"NAME"`
LastName string `json:"LAST_NAME"`
Export string `json:"EXPORT"`
AssignedByID b24.ID `json:"ASSIGNED_BY_ID"`
DateCreate string `json:"DATE_CREATE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"ID": "75",
"NAME": "Anastasia",
"LAST_NAME": "Ilyina",
"EXPORT": "Y",
"ASSIGNED_BY_ID": "6",
"DATE_CREATE": "2024-02-26T00:00:00+02:00",
"EMAIL": [
{
"ID": "215",
"VALUE_TYPE": "WORK",
"VALUE": "special-for@example.com",
"TYPE_ID": "EMAIL"
}
]
},
{
"ID": "74",
"NAME": "Artem",
"LAST_NAME": "Isaev",
"EXPORT": "Y",
"ASSIGNED_BY_ID": "1",
"DATE_CREATE": "2024-08-15T00:00:00+02:00",
"EMAIL": [
{
"ID": "214",
"VALUE_TYPE": "WORK",
"VALUE": "special-for@example.com",
"TYPE_ID": "EMAIL"
}
]
},
{
"ID": "78",
"NAME": "Artem",
"LAST_NAME": "Isaev",
"EXPORT": "Y",
"ASSIGNED_BY_ID": "1",
"DATE_CREATE": "2024-08-15T00:00:00+02:00",
"EMAIL": [
{
"ID": "218",
"VALUE_TYPE": "WORK",
"VALUE": "special-for@example.com",
"TYPE_ID": "EMAIL"
}
]
},
{
"ID": "77",
"NAME": "Inna",
"LAST_NAME": "Kuznetsova",
"EXPORT": "Y",
"ASSIGNED_BY_ID": "6",
"DATE_CREATE": "2024-07-01T00:00:00+02:00",
"EMAIL": [
{
"ID": "217",
"VALUE_TYPE": "WORK",
"VALUE": "special-for@example.com",
"TYPE_ID": "EMAIL"
}
]
},
{
"ID": "73",
"NAME": "Ivan",
"LAST_NAME": "Petrov",
"EXPORT": "Y",
"ASSIGNED_BY_ID": "1",
"DATE_CREATE": "2024-02-20T00:00:00+02:00",
"EMAIL": [
{
"ID": "213",
"VALUE_TYPE": "WORK",
"VALUE": "special-for@example.com",
"TYPE_ID": "EMAIL"
}
]
}
],
"total": 5,
"time": {
"start": 1723807142.916445,
"finish": 1723807143.44846,
"duration": 0.5320150852203369,
"processing": 0.1967020034790039,
"date_start": "2024-08-16T13:19:02+02:00",
"date_finish": "2024-08-16T13:19:03+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response. An array containing information about the found contacts. The fields of an individual contact are configured by the |
|
total |
The total number of contacts found based on the specified conditions |
|
next |
Contains the value to be passed in the next request in the The |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Access denied."
}
|
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 user does not have permission for "Read" contacts |
|
Empty value |
|
A non-array value was passed to the |
|
Empty value |
|
A non-array value was passed to the |
|
Empty value |
|
An unknown error occurred |
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 |