Rate this page:

GetUsersRequest

Props

acdQueueId
Optional
Copy URL
acdQueueId: 

number

The ACD queue ID to filter

acdStatus
Optional
Copy URL
acdStatus: 

string

|

string[]

The ACD status list separated by semicolons (;) to filter. The following values are possible: OFFLINE, ONLINE, READY, BANNED, IN_SERVICE, AFTER_SERVICE, TIMEOUT, DND

applicationId
Copy URL
applicationId: 

number

The application ID to filter

applicationName
Copy URL
applicationName: 

string

The application name part to filter

count
Optional
Copy URL
count: 

number

The maximum returning record count

excludedAcdQueueId
Optional
Copy URL
excludedAcdQueueId: 

number

The excluded ACD queue ID to filter

excludedSkillId
Optional
Copy URL
excludedSkillId: 

number

The excluded skill ID to filter

offset
Optional
Copy URL
offset: 

number

The first N records are skipped in the output

orderBy
Optional
Copy URL
orderBy: 

string

The following values are available: 'user_id', 'user_name' and 'user_display_name'

returnLiveBalance
Optional
Copy URL
returnLiveBalance: 

boolean

Whether to get the user live balance

showingSkillId
Optional
Copy URL
showingSkillId: 

number

The skill to show in the 'skills' field output

skillId
Optional
Copy URL
skillId: 

number

The skill ID to filter

userActive
Optional
Copy URL
userActive: 

boolean

Whether the user is active to filter. Inactive users cannot log in to applications

userDisplayName
Optional
Copy URL
userDisplayName: 

string

The user display name part to filter

userId
Optional
Copy URL
userId: 

number

The user ID to filter

userName
Optional
Copy URL
userName: 

string

The user name part to filter

withQueues
Optional
Copy URL
withQueues: 

boolean

Whether to get the bound queues

withSkills
Optional
Copy URL
withSkills: 

boolean

Whether to get the bound skills

Rate this page: