listUsers

GET

/auth/admin/list-users

List users

Authorizations

• bearerAuth

Parameters

Query Parameters

searchValue

The value to search for

string

searchField

The field to search in, defaults to email. Can be email or name

string

searchOperator

The operator to use for the search. Can be contains, starts_with or ends_with

string

limit

The number of users to return

string

offset

The offset to start from

string

sortBy

The field to sort by

string

sortDirection

The direction to sort by

string

filterField

The field to filter by

string

filterValue

The value to filter by

string

filterOperator

The operator to use for the filter

string

Responses

200

List of users

object

users

Array<object>

object

name

string

email

string

emailVerified

boolean

image

string

createdAt

date

updatedAt

date

role

string

banned

boolean

banReason

string

banExpires

date

username

string

isAnonymous

boolean

400

Bad Request. Usually due to missing parameters, or invalid parameters.

object

message

required

string

401

Unauthorized. Due to missing or invalid authentication.

object

message

required

string

403

Forbidden. You do not have permission to access this resource or to perform this action.

object

message

string

404

Not Found. The requested resource was not found.

object

message

string

429

Too Many Requests. You have exceeded the rate limit. Try again later.

object

message

string

500

Internal Server Error. This is a problem with the server that you cannot fix.

object

message

string