Sign in

v1

latestOpenAPI 3.0.42026-08-062942352.0 MB
Users

List all users

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

get/v3/users

Query parameters

pageinteger

The page number.

limitinteger

The number of records per page. Must be a number between 1 and 100.

sortstring

The sort string to sort the returned records e.g. "-createdAt"

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Unique identifier for the organization.

includeIncludeUserProperties[]

Whether to include related entities in the response.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Company of the user.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Organization associated with the user.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Unique identifier for the reseller.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Tags associated with the user.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Metadata key associated with the user.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Metadata value associated with the user.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

App version of the license activation associated with the user.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Release version of the license activation associated with the user.

lastSeenBeforestring date-time

Last datetime before which user used the app.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Unique identifier for the user group.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Role of the user.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Email address of the user.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Name of the user.

productIdstring

Unique identifier for the product.

eqstring date-time

Matches values that are equal to the specified value.

nestring date-time

Matches values that are not equal to the specified value.

gtstring date-time

Matches values that are greater than the specified value.

gtestring date-time

Matches values that are greater than or equal to the specified value.

ltstring date-time

Matches values that are less than the specified value.

ltestring date-time

Matches values that are less than or equal to the specified value.

Last datetime at which user used the app.

searchstring

Search string.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

ID of the resource.

eqstring date-time

Matches values that are equal to the specified value.

nestring date-time

Matches values that are not equal to the specified value.

gtstring date-time

Matches values that are greater than the specified value.

gtestring date-time

Matches values that are greater than or equal to the specified value.

ltstring date-time

Matches values that are less than the specified value.

ltestring date-time

Matches values that are less than or equal to the specified value.

Date of creation

eqstring date-time

Matches values that are equal to the specified value.

nestring date-time

Matches values that are not equal to the specified value.

gtstring date-time

Matches values that are greater than the specified value.

gtestring date-time

Matches values that are greater than or equal to the specified value.

ltstring date-time

Matches values that are less than the specified value.

ltestring date-time

Matches values that are less than or equal to the specified value.

Date of last update

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
firstNamestring required
lastNamestring required
emailstring required
rolestring required
twoFactorEnabledboolean required
googleSsoEnabledboolean required
lastLoginAtstring date-time nullable
companystring nullable
allowCustomerPortalAccessboolean required
rolesstring[] required
lastSeenAtstring date-time nullable
organizationIdstring nullable
resellerIdstring nullable
tagsstring[] required