Пользователи

Параметры запроса (query string)

• query — поисковая строка по ФИО или login

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

GET https://api.gigma.ru/api/users?query=Stewart

Ответ

При успешном действии возвращается HTTP код 200.

{
    "users": [
        {
            "id": 31,
            "role": {
                "id": 3,
                "name": "manager",
                "avatar": null,
                "description": "Руководитель отдела",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "branch": {
                "id": 1,
                "name": "ООО "АЙТЕКО"",
                "avatar": "https://api.gigma.ru/storage/uploads/9qzh2GCaYpRpaxXnql0JZYpIesu3qlvQLV2OBhcN.png",
                "created_at": "2024-03-27T07:26:29.000000Z"
            },
            "department": {
                "id": 1,
                "name": "Технический",
                "avatar": "https://api.gigma.ru/storage/uploads/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "login": "yaroslav42@er.fs",
            "phone": "71235512351",
            "first_name": "Jon",
            "last_name": "Doe",
            "middle_name": "Stewart",
            "birthday": "2024-07-03",
            "employment_date": null,
            "dismissal_date": null,
            "avatar": {
                "id": 456,
                "name": "photo.jpg",
                "type": { "id": 2, "name": "Аватар", "avatar": "https://api.gigma.ru/storage/uploads/default.svg", "created_at": "2024-03-27T07:00:46.000000Z" },
                "path": "https://api.gigma.ru/storage/uploads/YiSnszaC109sWAJKsvcWvK6IDR8sF1JC3X9Nve5X.jpg",
                "created_at": "2024-07-24T10:48:49.000000Z",
                "updated_at": "2024-07-24T10:48:49.000000Z"
            },
            "employment_contract": null,
            "is_banned": false,
            "is_sick": false,
            "creator": { "id": 1, "first_name": "Артём", "last_name": "Полищук", "middle_name": "Николаевич", "name": "Полищук Артём" },
            "active_time": 0,
            "last_activity_at": null,
            "permissions": [],
            "created_at": "2024-07-19T16:14:14.000000Z",
            "updated_at": "2024-07-25T12:19:56.000000Z"
        }
    ],
    "usersCount": 1
}

Описание полей ответа

• id — первичный ключ
• role — роль в системе (id, name, description)
• branch — филиал, к которому привязан
• department — отдел
• login — логин (email)
• phone — телефон
• first_name, last_name, middle_name, birthday — ФИО + ДР
• employment_date, dismissal_date — даты трудоустройства/увольнения
• avatar — объект файла аватара или null
• employment_contract — файл трудового договора или null
• is_banned, is_sick — флаги
• creator — кто завёл этого пользователя
• active_time, last_activity_at — активность
• permissions[] — массив прав доступа
• created_at, updated_at — таймстампы

Минимальный список пользователей, имеющих роль менеджера. Используется в фильтрах таблиц контрагентов, заказов и т.п.

Ответ

{
    "managers": [
        { "id": 1, "name": "Полищук Артём" },
        { "id": 2, "name": "Жуков Алексей" }
    ],
    "managersCount": 2
}

Описание полей ответа

• managers[] — массив: id, name (готовая склейка ФИО)
• managersCount — общее количество

Используется в фильтре «Ответственный» в таблице бизнесов и других местах.

Ответ

{
    "responsibleUsers": [
        { "id": 2, "name": "Жуков Алексей" },
        { "id": 3, "name": "Иванов Сергей" }
    ],
    "responsibleUsersCount": 2
}