Look up users

agId

string

Filter by an agent group ID.

no

buId

string

Filter by a business unit ID.

no

dateCreatedGT (query)

integer

Return a list of users based on dateCreated, where this is more than X number of days. Excludes rows where dateCreated is null or does not exist.

no

lastLogInDaysGT (query)

integer

Return a list of users based on lastLogin date, where this is more than X number of days. Excludes rows where lastLogin is null or does not exist.

no

max (query)

integer

Maximum number of records in response.

Maximum value: 1000.

no

10

neverLoggedIn (query)

Boolean

Returns a list of users whose lastLogin is equal to null.

no

offset (query)

integer

Number of skipped records from the start.

For example a combination of the "max: 10" and "offset: 10" parameters returns records 11 to 20.

no

0

order (query)

string

Order of records in result list. Supported values are:

• ASC (ascending)

• DESC (descending)

no

ASC

role

string

Filter by a role.

no

siteId (path)

integer

Site ID. Unique identifier assigned during client-account creation in Nuance Portal.

yes

sort (query)

string

Field name for sorting. Supported values are:

• id

• firstname

• lastname

• locked

• ssoUser

• username

no

username

usernames (query)

string

Comma-separated list of usernames. If provided, the query returns the users associated with the supplied usernames.

no

200

Request succeeded, and the response has content, which contains a list of users. This list is an array of objects with the following properties:

• activated

• disabled

• firstName

• lastName

• locked

• ssoUser

• tempLocked

• user id

• username

The respose object is described in the PaginatedUser model.

204

Request succeeded, and there is no content to send in the response.