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

Name	Type	In	Description
page	integer	query	The page number.
limit	integer	query	The number of records per page. Must be a number between 1 and 100.
sort	string	query	The sort string to sort the returned records e.g. "-createdAt"
organizationId	object	query	Unique identifier for the organization.
include	array	query	Whether to include related entities in the response.
company	object	query	Company of the user.
organization.name	object	query	Organization associated with the user.
resellerId	object	query	Unique identifier for the reseller.
tags	object	query	Tags associated with the user.
metadata.key	object	query	Metadata key associated with the user.
metadata.value	object	query	Metadata value associated with the user.
activation.appVersion	object	query	App version of the license activation associated with the user.
activation.releaseVersion	object	query	Release version of the license activation associated with the user.
userGroupId	object	query	Unique identifier for the user group.
role	object	query	Role of the user.
email	object	query	Email address of the user.
name	object	query	Name of the user.
productId	string	query	Unique identifier for the product.
lastSeenAt	object	query	Last datetime at which user used the app.
search	string	query	Search string.
id	object	query	ID of the resource.
createdAt	object	query	Date of creation
updatedAt	object	query	Date of last update

Responses

200

401

403

429

500

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",
      "organizationAlias": "string",
      "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"
    ]
  }
]