---
title: "Get Users"
method: GET
path: "/api/users"
tags: ["User"]
---

# Get Users

`GET /api/users`

Get all users

## Query parameters

- `offset` integer
- `limit` integer
- `username` string[]
- `search` string, nullable
- `admin` string[], nullable
- `status` 'active' | 'disabled' | 'limited' | 'expired' | 'on_hold'
- `sort` string

## Response `200`

Successful Response

- UsersResponse
  - `users` UserResponse[], required
    - `proxies` object, required
    - `expire` integer, nullable
    - `data_limit` integer, nullable — data_limit can be 0 or greater
    - `data_limit_reset_strategy` 'no_reset' | 'day' | 'week' | 'month' | 'year'
    - `inbounds` object
    - `note` string, nullable
    - `sub_updated_at` string, date-time, nullable
    - `sub_last_user_agent` string, nullable
    - `online_at` string, date-time, nullable
    - `on_hold_expire_duration` integer, nullable
    - `on_hold_timeout` string, date-time, nullable
    - `auto_delete_in_days` integer, nullable
    - `next_plan` NextPlanModel
      - `data_limit` integer, nullable
      - `expire` integer, nullable
      - `add_remaining_traffic` boolean
      - `fire_on_either` boolean
    - `username` string, required
    - `status` 'active' | 'disabled' | 'limited' | 'expired' | 'on_hold', required
    - `used_traffic` integer, required
    - `lifetime_used_traffic` integer
    - `created_at` string, date-time, required
    - `links` string[]
    - `subscription_url` string
    - `excluded_inbounds` object
    - `admin` Admin
      - `username` string, required
      - `is_sudo` boolean, required
      - `telegram_id` integer, nullable
      - `discord_webhook` string, nullable
      - `users_usage` integer, nullable
  - `total` integer, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.dev/atrvatam/apis/marzbanapi.md) · [All operations](https://skmtc.dev/atrvatam/apis/marzbanapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/atrvatam/marzbanapi/revisions/0aa31d6bd001/schema)