Accounts6

ActivationLogs3

Activations12

Analytics13

AuditLogs4

Authentication8

AutomatedEmailEventLogs3

AutomatedEmails6

BillingAddresses3

CreditCards1

EntitlementSets9

Environments5

FeatureFlags5

Features5

Invoices2

Licenses24

LicenseTemplates5

MaintenancePolicies6

OidcConfigurations4

OrganizationActivations2

OrganizationLicenses4

OrganizationProducts2

OrganizationReleases2

Organizations5

OrganizationSamlConfigurations4

OrganizationUserGroups5

OrganizationUsers5

PersonalAccessTokens6

Plans2

Products7

ProductVersions5

Profile15

ReleaseChannels5

ReleaseDownloadEvents3

ReleaseFiles4

ReleasePlatforms5

Releases11

ResellerActivations3

ResellerLicenses8

ResellerOrganizations5

Resellers5

ResellerUsers6

SamlConfigurations5

Segments5

SendingDomains9

Tags5

TrialActivations9

TrialPolicies5

Users10

WebhookEventLogs3

Webhooks7

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.

customAttributeobject

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

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

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

twoFactorRequiredFromstring date-time nullable

companystring nullable

allowCustomerPortalAccessboolean required

rolesstring[] required

lastSeenAtstring date-time nullable

organizationIdstring nullable

resellerIdstring nullable

tagsstring[] required

Changes

Changed in 1 of the 2 revisions of this API.16

Aug 18, 202666dcb629318016See the full diff
- ●
  deleted the query request parameter activation.appVersion
  request-parameter-removed
- ○
  added the new optional query request parameter customAttribute
  new-optional-request-parameter
- ○
  added the optional property items/twoFactorRequiredFrom to the response with the 200 status
  response-optional-property-added
- ○
  added the required property items/customAttributes to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/organization/customAttributes to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/organization/reseller/customAttributes to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/reseller/customAttributes to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history