Lists every account, newest first.

GET

/api/v1/admin/users

Errors

401 when nothing was signed in, 403 when the caller is not an administrator or used a bearer token, 404 when this instance has no administration.

Authorization

session

cookietessera_session<token>

Set by POST /auth/login. A browser sends it automatically; it is HttpOnly, so page scripts cannot read or set it.

Query Parameters

include_deleted?boolean

Include accounts that have been deleted.

Off by default. What is left of one identifies no person and cannot be acted on, so it belongs only in an answer that asked for it.

limit?integer

How many to return. Capped, and defaulted when omitted.

Formatint64

Range0 <= value

offset?integer

How many to skip.

Formatint64

Range0 <= value

Response Body

A page of accounts

application/json

response

A page of accounts.

data*array<>

The accounts on this page, newest first.

meta*

The collection they came from.

curl -X GET 'https://example.com/api/v1/admin/users'

{  "data": [    {      "email": "string",      "email_verified_at": "2019-08-24T14:15:22Z",      "has_password": true,      "id": "string",      "is_admin": true,      "must_change_password": true,      "permissions": [        "string"      ],      "quota_bytes": 0,      "roles": [        "string"      ],      "username": "string",      "max_file_bytes": 0,      "mfa_enabled": true,      "state": "active"    }  ],  "meta": {    "limit": 0,    "offset": 0,    "total": 0  }}