List all users

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

GET/v3/users
JWTuser:read

Query parameters

pageinteger

The page number.

Range: [1, 2147483647]Format: int32

limitinteger

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

Range: [1, 100]Format: int32

sortstring

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

Pattern: ([+-]\w*\.*\w*){1}(\|[+-]\w*){0,5}

organizationIdobject

Unique identifier for the organization.

includearray of string

Whether to include related entities in the response.

companyobject

Company of the user.

organization.nameobject

Organization associated with the user.

resellerIdobject

Unique identifier for the reseller.

tagsobject

Tags associated with the user.

metadata.keyobject

Metadata key associated with the user.

metadata.valueobject

Metadata value associated with the user.

customAttributeobject

Custom attribute values associated with the user, filtered as customAttribute.<name>[<op>]=value, e.g. customAttribute.region[eq]=EU.

activation.releaseVersionobject

Release version of the license activation associated with the user.

userGroupIdobject

Unique identifier for the user group.

roleobject

Role of the user.

emailobject

Email address of the user.

nameobject

Name of the user.

productIdstring

Unique identifier for the product.

Length: [0,256]

lastSeenAtobject

Last datetime at which user used the app.

searchstring

Search string.

Length: [0,256]

idobject

ID of the resource.

createdAtobject

Date of creation

updatedAtobject

Date of last update

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
firstNamestringrequired
lastNamestringrequired
emailstringrequired
rolestringrequired
twoFactorEnabledbooleanrequired
googleSsoEnabledbooleanrequired
allowCustomerPortalAccessbooleanrequired
metadataarray of objectrequired
customAttributesarray of objectrequired
tagsarray of stringrequired
lastLoginAtstring

Format: date-time

twoFactorRequiredFromstring

Format: date-time

companystring
lastSeenAtstring

Format: date-time

organizationIdstring
organizationobject
resellerIdstring
resellerobject