Admiral
Users

List the members of the current tenant

GET
/v1/users

Scope: user:read

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer admp_...

In: header

Query Parameters

filter?filter

Filter expression to narrow results. Uses the Admiral filter DSL (see the API documentation for the full operator and predicate reference).

Filterable fields:

  • email: filter by address.
  • status: filter by status.

Example: field['status'] = 'ACTIVE'

Lengthlength <= 1024
page_size?page_size

Maximum number of users to return per page. Defaults to 50 when omitted or 0; must not exceed 100.

Formatint32
Range0 <= value <= 100
page_token?page_token

Opaque pagination token from a previous response.

Response Body

application/json

curl -X GET "https://example.com/v1/users"
{  "users": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "email": "string",      "email_verified": true,      "display_name": "string",      "given_name": "string",      "family_name": "string",      "avatar_url": "string",      "created_at": "2023-01-15T01:30:15.01Z",      "updated_at": "2023-01-15T01:30:15.01Z",      "role": "USER_ROLE_UNSPECIFIED",      "status": "USER_STATUS_UNSPECIFIED"    }  ],  "next_page_token": "string"}

Retrieve a user by ID GET

Scope: `user:read`