Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Account Users

List all users in your account

List all users in your account

get/v1/users

Query parameters

searchstring

Search users by this string

Example:Elena
pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page (default = 10)

sort'first_name' | 'last_name' | 'email'

sort results by this property

direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "id": "8001dbd5-e28f-41df-aa67-107fc6dc83fc",
      "firstname": "Rocket",
      "lastname": "User",
      "email": "email@domain.tld",
      "roles": [
        "account_user",
        "user_admin"
      ],
      "twofactor_enabled": true,
      "twofactor_required": true
    }
  ]
}