Получить список контактов crm.contact.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь с правом «чтения» контактов
DEPRECATED
Развитие метода остановлено. Используйте crm.item.list.
Метод crm.contact.list возвращает список контактов по фильтру. Является реализацией списочного метода для контактов.
Чтобы получить список компаний, привязанных к контакту, используйте метод crm.contact.company.items.get
Параметры метода
|
Название |
Описание |
|
select |
Список полей, которые должны быть заполнены у контактов в выборке. При выборке можно использовать маски:
Маски для выборки множественных полей нет. Для выборки множественных полей укажите нужные в списке выбора ( Список доступных полей для выборки можно узнать с помощью метода По умолчанию берутся все поля — |
|
filter |
Объект формата:
где:
К ключам
Поля Телефон( Также фильтр Список доступных полей для фильтрации можно узнать с помощью метода Ключ |
|
order |
Объект формата:
где:
Список доступных полей для сортировки можно узнать с помощью метода |
|
start |
Параметр для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Также смотрите описание списочных методов.
Примеры кода
Как использовать примеры в документации
Получить список контактов, у которых:
- источником является CRM-Форма
- имя и фамилия не пустые
- имя или фамилия начинается на "И"
- участвуют в экспорте
- e-mail равен 'special-for@example.com'
- идентификатор ответственного или 1, или 6
- создан менее 6 месяцев назад
Задать порядок сортировки выборки: имя и фамилия в порядке возрастания.
Для наглядности выбрать только необходимые поля:
- Идентификатор контакта
- Имя
- Фамилия
- Участвует ли в экспорте
- Ответственный
- Дата создания
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FILTER":{"SOURCE_ID":"CRM_FORM","!=NAME":"","!=LAST_NAME":"","=%NAME":"И%","=%LAST_NAME":"И%","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":"И%","=%LAST_NAME":"И%","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': 'И%',
'=%LAST_NAME': 'И%',
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': 'И%',
'=%LAST_NAME': 'И%',
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' => 'И%',
'=%LAST_NAME' => 'И%',
'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": "И%",
"=%LAST_NAME": "И%",
"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' => 'И%',
'=%LAST_NAME' => 'И%',
'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>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "75",
"NAME": "Анастасия",
"LAST_NAME": "Ильина",
"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": "Артем",
"LAST_NAME": "Исаев",
"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": "Артем",
"LAST_NAME": "Исаев",
"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": "Инна",
"LAST_NAME": "Кузнецова",
"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": "Иван",
"LAST_NAME": "Петров",
"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"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Массив, содержащий информацию о найденных контактах. Поля отдельно взятого контакта конфигурируются параметром |
|
total |
Общее количество найденных контактов по заданным условиям |
|
next |
Содержит значение, которое нужно передать в следующий запрос в параметр Параметр |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
У пользователя нет прав на «Чтение» контактов |
|
|
|
В параметр |
|
|
|
В параметр |
|
|
|
Произошла неизвестная ошибка |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать новый контакт crm.contact.add
- Изменить контакт crm.contact.update
- Получить контакт по Id crm.contact.get
- Удалить контакт crm.contact.delete
- Получить поля контакта crm.contact.fields
- Как найти дубликаты в CRM по телефону и email