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

# GET /api/users

`GET /api/users`

## Request

- Base URL: `http://localhost:5002`
- URL: `http://localhost:5002/api/users`
- Auth: none declared. Required headers: `userid`, `authorization`

## Query parameters

- `status` 'approved' | 'pending'
- `name` string
- `email` string
- `referred_by` string
- `sort` 'ascend' | 'descend'
- `from_date` string, date
- `to_date` string, date
- `type` 'user' | 'admin' | 'superadmin' | 'unity'
- `limit` number
- `skip` number

## Headers

- `userid` string, required
- `authorization` string, required

## Response `default`

Successful

---

[API](https://skmtc.dev/breshna/apis/breshna-backend-apis.md) - [All operations](https://skmtc.dev/breshna/apis/breshna-backend-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/breshna/apis/breshna-backend-apis/revisions/c1038f1781fe?raw)