метод REST scope: mail

mail.recipient.listemployees

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

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

Описание

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

Метод mail.recipient.listemployees ищет сотрудников по имени или электронной почте.

Параметры

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":"Иван","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.listemployees

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 7,
                "email": "user@example.com",
                "name": "Иван Петров"
            }
        ]
    },
    "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_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Обязательное поле `query` не указано",
                "field": "query"
            }
        ]
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
Доступ запрещен Проверьте права пользователя и scope mail

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

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