Перейти к содержанию

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

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

Метод: GET
URL: https://beta.api.gigma.ru/users
Авторизация: Bearer token

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

  • query - поисковая строка

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

https://beta.api.gigma.ru/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": "http:\/\/localhost:8000\/\/storage\/uploads\/9qzh2GCaYpRpaxXnql0JZYpIesu3qlvQLV2OBhcN.png",
                "created_at": "2024-03-27T07:26:29.000000Z"
            },
            "department": {
                "id": 1,
                "name": "Технический",
                "avatar": "http:\/\/localhost:8000\/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": "modnyj-stil-smoking-solncezashhitnye-ochki.jpg",
                "type": {
                    "id": 2,
                    "name": "Аватар",
                    "avatar": "http:\/\/localhost:8000\/storage\/uploads\/default.svg",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                "path": "http:\/\/localhost:8000\/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"
        }
    ]
}

Описание полей ответа
  • id - первичный ключ пользователя
  • role - объект, содержащий роль пользователя в системе
  • branch - объект, содержащий данные о филиале текущего пользователя
  • department - объект, содержащий данные об отделе текущего пользователя
  • login - логин пользователя в системе (email)
  • phone - номер телефона
  • first_name - имя пользователя
  • last_name - фамилия пользователя
  • middle_name - отчество пользователя
  • birthday - дата рождения
  • employment_date - дата приема на работу
  • dismissal_date - дата увольнения
  • avatar - объект, содержащий информацию об аватаре пользователя. Для информации о полях объекта file
  • employmentContract - объект, содержащий документ "Трудовой договор"
  • is_banned - признак "Пользователь в бан-листе"
  • is_sick - признак "Пользователь на больничном"
  • creator - объект, содержащий информацию об администраторе, который добавил его в систему (поле "Назначил"). Описание возвращаемых полей соответствует текущему описанию
  • active_time - проведено времени в системе
  • last_activity_at - дата и время последней активности
  • permissions - массив объектов с информацией о правах доступа данного пользователя в системе
  • created_at - дата и время добавления в систему
  • updated_at - дата и время последних изменений