Skip to main content

Получить список пользователей

GET /users/​

Пример URL​

https://домен_системы/api/v2/users/?page=1&search=John Doe

Query-параметры​

ПараметрТипОбязательныйОписание
pageчислоНетНомер страницы (на странице показывается 30 пользователей)
searchстрокаНетПоиск
exact_searchчислоНетПоиск по полному совпадению значения "search" (0 - полное совпадение, 1 стандартный поиск)
group_listстрокаНетПоиск по ID группы пользователя (ID указываются через запятую)
id_listстрокаНетПоиск пользователей по ID (ID указываются через запятую)
from_date_createdстрокаНетДата создания "от". Пользователи, созданные с указанного момента (гггг-мм-дд чч:мм:сс)
to_date_createdстрокаНетДата создания "до". Пользователи, созданные до указанного момента (гггг-мм-дд чч:мм:сс)
from_date_updatedстрокаНетДата изменения "от". Пользователи, в которых были изменения с указанного момента (гггг-мм-дд чч:мм:сс)
to_date_updatedстрокаНетДата изменения "до". Пользователи, в которых были изменения до указанного момента (гггг-мм-дд чч:мм:сс)
order_byстрокаНетСортировка пользователей, через запятую. Пользователей можно сортировать по параметрам: date_created, date_updated, name. Порядок сортировки: {asc} - по возрастанию и {desc} - по убыванию; Значение по умолчанию - name{asc}
Пример ответа
{
    "data": [
        {
            "id": 414,
            "date_created": "2025-01-04 23:54:43",
            "date_updated": "2025-01-09 16:00:36",
            "name": " user test",
            "lastname": "",
            "alias": "",
            "email": "[email protected]",
            "phone": "1234567",
            "skype": "",
            "website": "",
            "organization": "",
            "status": "active",
            "language": "ru",
            "notifications": "1",
            "group": {
                "id": 45,
                "type": "user",
                "name": {
                    "ru": "Клиент",
                    "en": "Client"
                },
                "disable": 0
            },
            "ldap_username": null,
            "user_status": "offline",
            "department": [
                1
            ],
            "custom_fields": [
                {
                    "id": 37,
                    "field_type": "text",
                    "field_value": "Значение текстового поля"
                }
            ]
        }
    ],
    "pagination": {
        "total": 1,
        "per_page": 30,
        "current_page": 1,
        "total_pages": 1
    }
}