Получить список контактов crm.contact.list

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: crm

Кто может выполнять метод: любой пользователь с правом «чтения» контактов

DEPRECATED

Развитие метода остановлено. Используйте crm.item.list.

Метод crm.contact.list возвращает список контактов по фильтру. Является реализацией списочного метода для контактов.

Чтобы получить список компаний, привязанных к контакту, используйте метод crm.contact.company.items.get

Параметры метода

Название
тип

Описание

select
string[]

Список полей, которые должны быть заполнены у контактов в выборке.

При выборке можно использовать маски:

  • '*' — для выборки всех полей (без пользовательских и множественных)
  • 'UF_*' — для выборки всех пользовательских полей (без множественных)

Маски для выборки множественных полей нет. Для выборки множественных полей укажите нужные в списке выбора (PHONE, EMAIL и так далее).

Список доступных полей для выборки можно узнать с помощью метода crm.contact.fields.

По умолчанию берутся все поля — '*' + Пользовательские поля — 'UF_*'

filter
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
        

где:

  • field_n — название поля, по которому будет отфильтрована выборка элементов
  • value_n — значение фильтра

К ключам field_n можно добавить префикс, уточняющий работу фильтра.
Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • %= — LIKE (аналогично =%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

Поля Телефон(PHONE), Почта(EMAIL), Сайт(WEB), Мессенджеры(IM), Ссылки(LINK) — множественные. По ним фильтры работают только на точное совпадение.

Также фильтр LIKE не работает с полями типа crm_status, crm_contact, crm_company — например, Тип контакта (TYPE_ID), Обращение (HONORIFIC) и так далее.

Список доступных полей для фильтрации можно узнать с помощью метода crm.contact.fields.

Ключ logic в фильтре не поддерживается. Для использования сложной логики в фильтре используйте метод crm.item.list

order
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
        

где:

  • field_n — название поля, по которому будет произведена сортировка выборки контактов
  • value_n — значение типа string, равное:
    • ASC — сортировка по возрастанию
    • DESC — сортировка по убыванию

Список доступных полей для сортировки можно узнать с помощью метода crm.contact.fields

start
integer

Параметр для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

Также смотрите описание списочных методов.

Примеры кода

Как использовать примеры в документации

Получить список контактов, у которых:

  1. источником является CRM-Форма
  2. имя и фамилия не пустые
  3. имя или фамилия начинается на "И"
  4. участвуют в экспорте
  5. e-mail равен 'special-for@example.com'
  6. идентификатор ответственного или 1, или 6
  7. создан менее 6 месяцев назад

Задать порядок сортировки выборки: имя и фамилия в порядке возрастания.

Для наглядности выбрать только необходимые поля:

  • Идентификатор контакта
  • Имя
  • Фамилия
  • E-mail
  • Участвует ли в экспорте
  • Ответственный
  • Дата создания
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
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(new Date().getMonth() - 6);
        
        try {
          const response = await $b24.callListMethod(
            '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())
              ;
            }
          );
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(new Date().getMonth() - 6);
        
        try {
          const generator = $b24.fetchListMethod('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",
            ],
          }, 'ID');
          for await (const page of generator) {
            for (const entity of page) {
              console.log('Entity:', entity);
            }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(new Date().getMonth() - 6);
        
        try {
          const response = await $b24.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",
            ],
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) {
            console.log('Entity:', entity);
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
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
contact[]

Корневой элемент ответа. Массив, содержащий информацию о найденных контактах.

Поля отдельно взятого контакта конфигурируются параметром select

total
integer

Общее количество найденных контактов по заданным условиям

next
integer

Содержит значение, которое нужно передать в следующий запрос в параметр start, чтобы получить следующую порцию данных.

Параметр next появляется в ответе, если количество элементов, соответствующих вашему запросу, превышает значение 50

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

-

Access denied

У пользователя нет прав на «Чтение» контактов

-

Parameter 'order' must be array

В параметр order передан не массив

-

Parameter 'filter' must be array

В параметр filter передан не массив

-

Failed to get list. General error

Произошла неизвестная ошибка

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение