Search Users
POST https://{{axpAPIDomain}}/api/admin/user/v1/accounts/:accountId/users:search?pageNumber=2&pageSize=5
This API requires the Account Administrator role.
Searches the user list based on criteria provided.
This data includes basic details of each user and available features including current status for features operation progress.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageNumber | number | The page number of the records to retrieve. Default value is 1. | |
pageSize | number | The max number of records to retrieve per page. Default value is 10. | |
Request Body
{"filter"=>[{"discriminator"=>"AND", "key"=>"firstName", "operator"=>"STARTS_WITH", "value"=>"Steven"}], "orderBy"=>"firstName desc"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
appkey | string | ||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"pagination":{"pageNumber":2,"pageSize":10,"total":45},"users":[{"organizationNodeId":"EXMPLE","userId":"c8c2909d-75e9-484a-94c0-b7e8d29771fe","loginId":"stevens@avaya.com","lastName":"Stevens","firstName":"Alex","displayName":"Stevens, Alex","emailId":"stevens@avaya.com","profileId":"FSADSJ","memberOfGroups":["c8c2909d-75e9-484a-94c0-b7e8d29771fe"],"ownedGroups":["a8b6d39c-53c5-4d94-a640-c28bee987ed7"],"roles":["Agent"],"addresses":[{"addressId":"c8c2909d-75e9-484a-94c0-b7e8d29771fe","addressName":"Address Name","addressType":"OFFICE","addressTypeNumber":"101","streetNumber":"A11","streetName":"Allstate Pkwy","city":"Markham","state":"ON","countryCode":"ZW","zip":"L3R9T8","isDefault":false}],"accountAddresses":[{"addressId":"c8c2909d-75e9-484a-94c0-b7e8d29771fe","isDefault":false}],"features":{"matching":{"attributes":["Language.English","Language.French"],"queues":[{"queueId":"620bbb28-7112-433a-af59-17ee0f15a247","proficiency":10},{"queueId":"07d2c0a3-f05c-47e7-a86e-51148d3d4fd4","proficiency":6}]},"chat":{"autoAnswer":false,"multiplicity":2,"afterContactWork":false,"providers":[{"providerAgentId":"stevens@avaya.com","channelProviderId":"d7c2909d-75e9-484a-94c0-b7e8d30771dd"}]},"messaging":{"autoAnswer":false,"multiplicity":2,"afterContactWork":false,"providers":[{"providerAgentId":"stevens@avaya.com","channelProviderId":"d7c2909d-75e9-484a-94c0-b7e8d30771dd"}]},"email":{"autoAnswer":false,"multiplicity":2,"afterContactWork":false,"providers":[{"providerAgentId":"stevens@avaya.com","channelProviderId":"d7c2909d-75e9-484a-94c0-b7e8d30771dd"}]},"voice":{"autoAnswer":false,"afterContactWork":false,"userExtension":"10021","emergencyLocationIdentificationNumber":"7798098090","providers":[{"providerAgentId":"stevens@avaya.com","channelProviderId":"d7c2909d-75e9-484a-94c0-b7e8d30771dd"}]},"cmvoice":{"agentLoginId":11021,"agentPassword":81238,"extensionNumber":1111,"communicationProfileAddresses":[{"address":"10022@SipDomain1.com","type":"SIP","isDefault":true},{"address":"+12345@avaya.com","type":"E164","isDefault":false}],"communicationProfilePassword":"anypasswordstring"},"aci":{},"recorder":{},"outbound":{}}}],"links":{"prev":"/api/admin/user/v1/accounts/ASDJGE/users:search?pageNumber=1\u0026pageSize=10","next":"/api/admin/user/v1/accounts/ASDJGE/users:search?pageNumber=3\u0026pageSize=10"}}