listUsers

GET

/admin/list-users

curl --request GET \
  --url 'https://gymgym.club/api/auth/admin/list-users?searchField=email&searchOperator=contains&sortDirection=asc&filterOperator=eq' \
  --header 'Authorization: Bearer <token>'

List users

Authorizations

• bearerAuth

Parameters

Query Parameters

searchValue

string

searchField

The field to search in, defaults to email. Can be email or name. Eg: “name”

string

Allowed values: email name

searchOperator

The operator to use for the search. Can be contains, starts_with or ends_with. Eg: “contains”

string

Allowed values: contains starts_with ends_with

limit

Any of:

string

The number of users to return

string

number

number

offset

Any of:

string

The offset to start from

string

number

number

sortBy

The field to sort by

string

sortDirection

The direction to sort by

string

Allowed values: asc desc

filterField

The field to filter by

string

filterValue

Any of:

unknown

Any of:

unknown

Any of:

unknown

Any of:

string

The value to filter by

string

number

number

boolean

boolean

Array<string>

Array<string>

Array<number>

Array<number>

filterOperator

The operator to use for the filter

string

Allowed values: eq ne lt lte gt gte in not_in contains starts_with ends_with

Responses

200

List of users

Media typeapplication/json

object

users

required

Array<object>

object

id

required

string

name

required

string

email

required

string

emailVerified

required

boolean

image

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

role

string

banned

boolean

banReason

string

banExpires

string format: date-time

isAnonymous

boolean

lastLoginMethod

string

total

required

number

limit

number

offset

number

Example

{
  "users": [
    {
      "emailVerified": false,
      "banned": false,
      "isAnonymous": false
    }
  ]
}

400

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

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

401

Unauthorized. Due to missing or invalid authentication.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

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

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

404

Not Found. The requested resource was not found.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

429

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

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

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

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}