List all users

Returns a list of users. The users are returned sorted by creation date in ascending order.

GET/v3/users
JWT
user:read

Parameters

NameTypeInDescription
pageintegerqueryThe page number.
limitintegerqueryThe number of records per page. Must be a number between 1 and 100.
sortstringqueryThe sort string to sort the returned records e.g. "-createdAt"
companyobjectqueryCompany of the user.
organization.nameobjectqueryOrganization associated with the user.
resellerIdobjectqueryUnique identifier for the reseller.
tagsobjectqueryTags associated with the user.
metadata.keyobjectqueryMetadata key associated with the user.
metadata.valueobjectqueryMetadata value associated with the user.
activation.appVersionobjectqueryApp version of the license activation associated with the user.
activation.releaseVersionobjectqueryRelease version of the license activation associated with the user.
organizationIdobjectqueryUnique identifier for the organization.
roleobjectqueryRole of the user.
emailobjectqueryEmail address of the user.
nameobjectqueryName of the user.
productIdstringqueryUnique identifier for the product.
lastSeenAtobjectqueryLast datetime at which user used the app.
searchstringquerySearch string.
idobjectqueryID of the resource.
createdAtobjectqueryDate of creation
updatedAtobjectqueryDate of last update

Responses

200 OK
[
  {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "role": "string",
    "twoFactorEnabled": true,
    "googleSsoEnabled": true,
    "lastLoginAt": "2019-08-24T14:15:22Z",
    "company": "string",
    "allowCustomerPortalAccess": true,
    "roles": [
      "string"
    ],
    "lastSeenAt": "2019-08-24T14:15:22Z",
    "organizationId": "string",
    "organization": {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "email": "string",
      "description": "string",
      "allowedUsers": 0,
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      },
      "resellerId": "string",
      "reseller": {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "email": "string",
        "description": "string",
        "allowedUsers": 0,
        "allowedOrganizations": 0
      }
    },
    "resellerId": "string",
    "reseller": {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "email": "string",
      "description": "string",
      "allowedUsers": 0,
      "allowedOrganizations": 0
    },
    "metadata": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "key": "string",
        "value": "string",
        "viewPermissions": [
          "activation"
        ],
        "visible": true
      }
    ],
    "tags": [
      "string"
    ],
    "emailPreference": {
      "metrics": true
    }
  }
]