v1

latestOpenAPI 3.0.02026-07-175652103.9 KB
user

Get the List of Users

This function is an API endpoint that allows an authenticated admin to retrieve a paginated list of users. It is tagged with "user" for OpenAPI documentation.

Parameters

  • current: The current page number.

  • pageSize: The number of users per page.

  • email: The email to filter the users by.

  • name: The name to filter the users by.

Returns

If successful, this function returns a Json<UserList> object, which includes a success message, the total number of users, and the list of users. <br> If no users are found, this function returns a status::NotFound error. <br>

Errors

This function will return an error if the system is in maintenance mode, or if no users are found.

Example

GET /api/user-list?current=1&pageSize=10&email=test@test.com&name=Test

get/api/user-list

Query parameters

currentinteger required
pageSizeinteger required
emailstring nullable
namestring nullable

Response

msgstring required
totalinteger required