BEbencherdev
users

List users

Changed on

List all users. The user must be an admin on the server to use this route. The HTTP response header X-Total-Count contains the total number of users.

get/v0/users

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

direction'asc' | 'desc'

The direction to sort by. If not specified, the default sort direction is used.

pageinteger nullable

The page number to return. If not specified, the first page is returned.

per_pageinteger nullable

The number of items to return per page. If not specified, the default number of items per page (8) is used.

sort'name'

Sort by user name.

The field to sort by. If not specified, the default sort field is used.

namestring

Filter by user name, exact match.

searchstring

Search by user name, slug, or UUID.

Response

successful operation

adminboolean required
createdstring date-time
emailstring required
lockedboolean required
namestring required
slugstring required
uuidstring uuid required

Changes