Sign in
User Account

Search users as admin

Changed on

Searches users across all accounts for authenticated administrators. Text filters use case-insensitive substring matching. query searches email, first name, and last name; email, firstName, and lastName restrict the match to one field. tier and role filters use exact values. Results use deterministic keyset pagination. The default sort is name ascending; override it by providing both sort and order. Every sort uses userId as a deterministic tie-breaker. This response always uses Cache-Control: no-store.

get/api/v1/admin/users

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/admin/users
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

querystring

Optional case-insensitive substring query across email, first name, and last name.

emailstring

Optional case-insensitive substring filter for the email address.

firstNamestring

Optional case-insensitive substring filter for the first name.

lastNamestring

Optional case-insensitive substring filter for the last name.

tierUserTierData[]

Optional filter by one or more user subscription tiers.

[
  "FREE"
]
roleUserRoleData[]

Optional filter by one or more user roles.

[
  "USER"
]
created[min]string date-time

Optional lower bound for the user's created timestamp (RFC3339).

created[max]string date-time

Optional upper bound for the user's created timestamp (RFC3339).

updated[min]string date-time

Optional lower bound for the user's updated timestamp (RFC3339).

updated[max]string date-time

Optional upper bound for the user's updated timestamp (RFC3339).

sort'name' | 'email' | 'firstName' | 'lastName' | 'tier' | 'role' | 'updated' | 'created'

Fields available for sorting admin user-search results:

  • name: First name followed by last name
  • email: User email address
  • firstName: User first name
  • lastName: User last name
  • tier: User subscription tier
  • role: User role
  • updated: Last update timestamp
  • created: Creation timestamp Every sort uses user ID as a deterministic tie-breaker.
Example:email

Field used for ordering results. Valid fields are name, email, firstName, lastName, tier, role, created, and updated. The default is name ascending. To override it, provide both sort and order.

order'asc' | 'desc'

Sort direction for sort. Ignored unless sort is also provided; when both are absent, results use name ascending.

searchAfterstring

Opaque User ID cursor for keyset pagination. Pass the searchAfter string returned by the previous response to fetch the next page. Requests may also provide the legacy JSON array form when its final element is a valid User ID. The cursor is valid only with the same filters and sort used for the previous page.

sizeinteger

Number of users requested per page. The server clamps values to the inclusive range 1–100.

Response

Users returned successfully.

sizeinteger required

Number of items returned in the current page.

searchAfterstring

User ID cursor for the next page, omitted when more results are unavailable.

totalinteger

Total matching users when the reader provides it; omitted otherwise.

Example response

{
  "items": [
    {
      "tier": "FREE",
      "role": "USER"
    }
  ],
  "size": 21,
  "searchAfter": "usr_681w9znhe8eawrhebxd1046d44",
  "total": 42
}

Changes

  • 927a680d096bRevision changes
    • breaking

      the response property's min was decreased from 1.00 to 0.00 for the response status

  • 999eda3fdd63Revision changes
    • breaking

      the // response's property format changed from uuid to no format for status

    • breaking

      the response's property format changed from uuid to no format for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      for the query request parameter searchAfter, the format was generalized from uuid to no format

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status