метод REST scope: mail

mail.recipient.listcontacts

Получить список контактов

Кто может выполнять: любой пользователь

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод mail.recipient.listcontacts ищет контакты в адресной книге текущего пользователя.

Параметры

query string необязательный

Поисковая строка по имени или электронной почте контакта.

Если не передан, метод возвращает последние контакты

pagination object необязательный

Параметры постраничной навигации:
- page — номер страницы
- limit — количество записей на страницу, по умолчанию 50, максимум 200
- offset — смещение записей. Если переданы page и limit, смещение вычисляется автоматически

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"query":"client","pagination":{"page":1,"limit":20,"offset":0}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.recipient.listcontacts

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 10,
                "email": "client@example.com",
                "name": "Client"
            }
        ]
    },
    "time": {
        "start": 1779820087,
        "finish": 1779820087.962438,
        "duration": 0.9624381065368652,
        "processing": 0,
        "date_start": "2026-05-26T21:28:07+03:00",
        "date_finish": "2026-05-26T21:28:07+03:00",
        "operating_reset_at": 1779820687,
        "operating": 0
    }
}

Возвращаемые данные

result object

Объект с данными ответа

items array

Массив объектов контактов

items[] object

Объект контакта

id integer

Идентификатор контакта

email string

Email контакта

name string

Имя контакта

time time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION",
        "message": "Не удается распознать параметр пагинации `{\"limit\":\"abc\"}`"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
Доступ запрещен Проверьте права пользователя и scope mail

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.