---
title: "Get Users for client"
method: GET
path: "/api/users"
tags: ["user"]
---

# Get Users for client

`GET /api/users`

This function is an API endpoint that retrieves all users.

## Parameters

- `current`: The current page number for pagination. This parameter is currently unused.

- `pageSize`: The number of items per page for pagination. This parameter is currently unused.

- `accessible`: A boolean value indicating whether the user is accessible. This parameter is currently unused.

- `status`: The status of the user. This parameter is currently unused.

## Returns

If successful, this function returns a `Json<UserList>` object containing the users.

## Query parameters

- `current` integer, required
- `pageSize` integer, required
- `accessible` boolean, nullable
- `status` integer, nullable

## Response `200`

- UserList
  - `msg` string, required
  - `total` integer, required
  - `data` UserListResponse[], required
    - `guid` string, required
    - `name` string, required
    - `email` string, required
    - `note` string, nullable
    - `status` integer, required
    - `group_name` string, required
    - `is_admin` boolean, required

## Other responses

- `404`

## Changes

- **2024-05-20** `b66a109db88a` — 2 info
  - api tag `user` added
  - api tag `User` removed
- **2024-05-19** `fafd43b82c78` — 2 info
  - api tag `User` added
  - api tag `user` removed

[Change history](https://skmtc.dev/nesaku/apis/sctgdesk-api-server/changes/api/users/get.md)

---

[API](https://skmtc.dev/nesaku/apis/sctgdesk-api-server.md) · [All operations](https://skmtc.dev/nesaku/apis/sctgdesk-api-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nesaku/sctgdesk-api-server/revisions/0388fec8a751/schema)
