---
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
- `lang` 'en' | 'ru', required
- `page` integer, required
- `pageSize` integer, required
- `sort` string, required
- `type` 'sort' | 'filter' | 'init' | 'page' | 'size', required

## Response `200`

users list received successful

- object
  - `data` object
    - `total` integer
    - `users` ModelsUserRoleTenant[]
      - `hash` string
      - `id` integer
      - `mail` string, required
      - `name` string, required
      - `password_change_required` boolean
      - `role` ModelsRole
        - `id` integer
        - `name` string, required
      - `role_id` integer
      - `status` 'created' | 'active' | 'blocked', required
      - `tenant` ModelsTenant
        - `description` string
        - `hash` string, required
        - `id` integer
        - `status` 'active' | 'blocked', required
      - `tenant_id` integer
      - `type` 'local' | 'oauth', required
  - `status` string

## Other responses

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

---

[API](https://skmtc.net/vxcontrol/apis/soldr-swagger-api.md) · [All operations](https://skmtc.net/vxcontrol/apis/soldr-swagger-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vxcontrol/soldr-swagger-api/versions/ac519ec936b3/schema)