admin

List users (admin)

Changed on

Paginated list of all users on the instance. Supports search by username/email. Exposes fields hidden from the normal user API (is_admin, status).

get/admin/users

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/admin/users
  • Auth
    API key in header Authorization

Query parameters

sstring

Search string matched against username and email.

pageinteger

Page number, defaults to 1.

per_pageinteger

Items per page, defaults to the service setting.

Response

OK

auth_providerstring
bot_owner_idinteger

BotOwnerID is the ID of the owning (human) user if this user is a bot. A non-zero value means this user is a bot and cannot authenticate via password.

createdstring

A timestamp when this task was created. You cannot change this value.

emailstring

The user's email address.

idinteger

The unique, numeric id of this user.

is_adminboolean
issuerstring
namestring

The full name of the user.

status0 | 1 | 2 | 3
subjectstring
updatedstring

A timestamp when this task was last updated. You cannot change this value.

usernamestring

The username of the user. Is always unique.

Changes