---
title: "Retrieve users list by filters"
method: GET
path: "/users/"
tags: ["Users"]
---

# Retrieve users list by filters

`GET /users/`

## Query parameters

- `filters[]` string[]
- `group` string
- `page` integer, required
- `pageSize` integer
- `sort[]` string[]
- `type` 'sort' | 'filter' | 'init' | 'page' | 'size', required

## Response `200`

users list received successful

- object
  - `data` object
    - `total` integer
    - `users` ModelsUserRole[]
      - `created_at` string
      - `hash` string
      - `id` integer
      - `mail` string, required
      - `name` string
      - `password_change_required` boolean
      - `provider` string
      - `role` ModelsRole
        - `id` integer
        - `name` string, required
      - `role_id` integer, required
      - `status` string, required
      - `type` string, required
  - `status` string

## Other responses

- `400` — invalid query request data
- `403` — getting users not permitted
- `500` — internal error on getting users

---

[API](https://skmtc.dev/vxcontrol/apis/pentagi-swagger-api.md) · [All operations](https://skmtc.dev/vxcontrol/apis/pentagi-swagger-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vxcontrol/pentagi-swagger-api/revisions/7c1cbf7abaa1/schema)