GETTING STARTED
Introduction to SmartAssist
Glossary
SmartAssist Lifecycle Management
SmartAssist Setup Guide
Sign Up for SmartAssist
Release Notes
Recent Updates
Previous Versions
Frequently Asked Questions (FAQ)

EXPERIENCE DESIGNERS
Flow Designer
Introduction
Create Experience Flows
Navigate the Flow Designer
Experience Flow Nodes
Introduction
Node Types
IVR Menu
IVR Digit Input
Conversational Input
Split
Check Agent Availability
Check Business Hours
Message Prompt
Run Automation
Agent Transfer
Connect to API
Go to Flow
Deflect to Chat
Script Task
Set Queue
End Flow
Waiting Experience
Conversation Automation
Testing Widget
Use Cases
Overview
Questions & Answers
Conversations

ADMINISTRATORS
Account Management
Switch Account
Invite Developers to an Account
Routing
Skills
Skill Groups
Queues
Hours of Operation
Default Flows
User Management
Users
Agent Groups
Agent Settings
Role Management
Agent Status
System Setup
Channels
Voice
Chat
Email
Limitations With Accounts Using AudioCodes
Agent Transfer
Surveys
Agent Forms
Dispositions
Language & Speech
Overview
Language Management
Voice Preferences
Hold Audio
Standard Responses
Handling Sensitive Data
Widgets
Utils
AgentAssist Settings
SearchAssist
Advanced Settings
Co-Browse Settings
Community WFM (Beta)
Automatic Conversation Summary (Beta)
Intelligent Agent Tools
Sensitive Data Masking
API Reference
API Setup
API List
Integrations
Genesys Voice Bot
Genesys + Kore Voice Automation - Manual Installation Guide
Voice Automation - Integration with Amazon Connect
Voice Automation NiceCX (CX One) - SIP Integration
Talkdesk Voice Automation
ID R&D Integration With Kore
Audit Report

AGENTS
Agent Console
Introduction
Conversation Tray
Incoming Interactions
Interacting with Customers
Additional Tools
My Dashboard

SUPERVISORS
Dashboard
Automation
Queues and Agents
Interactions
Monitor Queues, Agents, Interactions, and Service Levels
Manage Layout

BUSINESS USERS
Reports
Introduction
Reports List

List All Agents

To retrieve the list of all agents with the given Stream Id.

Method GET
Endpoint https://{{host}}/agentassist/api/v1/public/{{StreamId}}/agents?page=1&includeQueues=True
Content-Type application/json
Authorization auth: {{JWT}}
See How to generate the JWT Token.
API Scope SmartAssist Analytics

 

Path Parameters

 

Parameter Description Type
host Environment URL, for example, https://smartassist.kore.ai String, Required
BotId BotId or StreamId. You can access it from the General Settings page of the bot. String, Required

 

Query Parameters

Parameter Description Type
page The page number to return. The default is 1. Integer, Optional
includeQueues Whether to include queues in response. Boolean, Optional

 

Sample Request

curl --location 'https://{{host}}/agentassist/api/v1/public/{{StreamId}}/agents?page=1&includeQueues=True' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'
--header 'accountId: {{YOUR_accountId}}'

 

Sample Response

{
    "results": [
        {
            "status": "ACTIVE",
            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "accountId": "6201eaad257a163e989ad095",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "accessLevel": "full",
                    "role": "manager",
                    "groupName": "Default Group"
                },
                {
                    "groupId": "ag-30ecdc8-19d2-40e8-a0b9-e938731997a3",
                    "accessLevel": "full",
                    "role": "manager",
                    "groupName": "New Group"
                }
            ],
            "canSupportChat": true,
            "maxChatSupport": 5,
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": true,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": true,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": true,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": true,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "roleId": "6201eaad257a163e989ad0a4",
            "createdAt": "2022-02-08T04:00:19.156Z",
            "updatedAt": "2023-05-11T07:29:25.278Z",
            "lastOnlineAt": "2023-05-11T07:29:25.278Z",
            "desktopLayouts": [
                {
                    "isDefault": false,
                    "id": "ly-ca5231e-9b44-4b39-ac8d-0b36202a3b8d"
                },
                {
                    "isDefault": true,
                    "id": "ly-92d92b7-4798-419a-a719-07aab1a6ebb1"
                },
                {
                    "isDefault": false,
                    "id": "ly-b0ed0dc-7dec-4d7c-8933-78797a222a4a"
                }
            ],
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "isAccountOwner": true,
            "sipURI": "sip:supportuat94@smartassist-agent-np.kore.ai:5060",
            "id": "a-1353078-d362-4d5e-95ed-554056e71750",
            "emailId": "john.doe@domain.com",
            "firstName": "John",
            "lastName": "Doe",
            "nickName": "John",
            "phoneNumber": "221421421421",
            "profImage": "no-avatar",
            "skills": [
                {
                    "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
                    "skillId": "641847bf731b5d4baa2d991f",
                    "proficiencyLevel": "average",
                    "name": "Blue Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "641847bf731b5d4baa2d991f"
                },
                {
                    "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
                    "skillId": "641847d1731b5d4baa2ded62",
                    "proficiencyLevel": "average",
                    "name": "Red Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "641847d1731b5d4baa2ded62"
                },
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": true,
                            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Administrator"
        },
        {
            "status": "ACTIVE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "canSupportChat": true,
            "maxChatSupport": 20,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "userId": "u-70b19d34-e795-5059-b687-484c0bc1f795",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "manager",
                    "accessLevel": "view",
                    "groupName": "Default Group"
                }
            ],
            "createdAt": "2022-03-15T12:40:33.177Z",
            "updatedAt": "2023-03-06T05:55:20.517Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "lastOnlineAt": "2023-03-06T05:55:20.517Z",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-898331c-c9e6-4918-9501-6c2626198b32",
            "emailId": "jane.doe@domain.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "nickName": "Jane",
            "phoneNumber": "9000011111",
            "profImage": "no-avatar",
            "skills": [],
            "queues": [
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-70b19d34-e795-5059-b687-484c0bc1f795"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-70b19d34-e795-5059-b687-484c0bc1f795"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "userId": "u-16a7d3ce-1545-51a0-aa34-ce9de87304f2",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "agent",
                    "groupName": "Default Group"
                }
            ],
            "createdAt": "2022-03-22T05:12:26.645Z",
            "updatedAt": "2023-03-06T05:55:20.583Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "lastOnlineAt": "2023-03-06T05:55:20.583Z",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-9c4b773-14ba-4295-8cc1-569036a80b92",
            "emailId": "john.smith@domain.com",
            "firstName": "John",
            "lastName": "Smith",
            "nickName": "John",
            "phoneNumber": "12343112352",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-16a7d3ce-1545-51a0-aa34-ce9de87304f2",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-16a7d3ce-1545-51a0-aa34-ce9de87304f2"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-16a7d3ce-1545-51a0-aa34-ce9de87304f2"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "agent",
                    "groupName": "Default Group"
                }
            ],
            "createdAt": "2022-05-31T12:56:04.376Z",
            "updatedAt": "2023-03-06T05:55:20.610Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "lastOnlineAt": "2023-03-06T05:55:20.610Z",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-397ca96-3c55-4b85-ab36-2b707d243125",
            "emailId": "clark.kent@domain.com",
            "firstName": "Clark",
            "lastName": "Kent",
            "nickName": "Clark",
            "phoneNumber": "9000022222",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "manager",
                    "accessLevel": "full",
                    "groupName": "Default Group"
                }
            ],
            "createdAt": "2022-05-31T14:47:14.819Z",
            "updatedAt": "2023-05-10T16:04:30.609Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "lastOnlineAt": "2023-05-10T16:04:30.608Z",
            "desktopLayouts": [
                {
                    "isDefault": true,
                    "id": "ly-ca5231e-9b44-4b39-ac8d-0b36202a3b8d"
                },
                {
                    "isDefault": false,
                    "id": "ly-4c5be1d-6ca9-49ac-ac54-578e0e097e79"
                },
                {
                    "isDefault": false,
                    "id": "ly-9e304bb-cb55-443e-96ab-14640b754a35"
                }
            ],
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-5978284-a164-41d2-b1d5-b22b1d91ad4d",
            "emailId": "lois.lane@domain.com",
            "firstName": "Lois",
            "lastName": "Lane",
            "nickName": "LLane",
            "phoneNumber": "12353673712",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": true,
                            "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "desktopLayouts": [],
            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "agent",
                    "groupName": "Default Group"
                }
            ],
            "lastOnlineAt": "2023-03-06T05:55:20.546Z",
            "createdAt": "2022-10-19T09:34:17.290Z",
            "updatedAt": "2023-03-06T05:55:20.546Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-4088962-3642-40ae-88dc-c578d48c793d",
            "emailId": "henry.higgins@domain.com",
            "firstName": "Henry",
            "lastName": "Higgins",
            "nickName": "Henry",
            "phoneNumber": "121212124151",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "desktopLayouts": [
                {
                    "isDefault": false,
                    "id": "ly-9e304bb-cb55-443e-96ab-14640b754a35"
                }
            ],
            "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-30ecdc8-19d2-40e8-a0b9-e938731997a3",
                    "role": "agent",
                    "groupName": "New Group"
                }
            ],
            "lastOnlineAt": "2023-03-06T05:55:20.628Z",
            "createdAt": "2022-11-01T10:49:33.148Z",
            "updatedAt": "2023-03-06T05:55:20.628Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-1aba421-7d05-41a5-a47a-daa450655bb0",
            "emailId": "ann_chovey@domain.com",
            "firstName": "Ann",
            "lastName": "Chovey",
            "nickName": "Ann",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "accountId": "6201eaad257a163e989ad095",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "agent",
                    "groupName": "Default Group"
                }
            ],
            "canSupportChat": true,
            "maxChatSupport": 5,
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                }
            ],
            "createdBy": "u-81191025-27fa-574b-b5ce-f91aa5b47094",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "roleId": "6389e47741afba5c08bfd48e",
            "lastOnlineAt": "2023-03-06T05:55:20.644Z",
            "desktopLayouts": [],
            "createdAt": "2022-11-07T08:45:02.797Z",
            "updatedAt": "2023-03-06T05:55:20.644Z",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-e53ad77-1b44-424c-933e-30474ad3d9c6",
            "emailId": "rita_book@domain.com",
            "firstName": "Rita",
            "lastName": "Book",
            "nickName": "Rita",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6201eaad257a163e989ad0a4",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": false,
            "voiceLanguageSupport": [
                {
                    "isActive": false,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "desktopLayouts": [
                {
                    "isDefault": true,
                    "id": "ly-86ed061-3a2e-4aa0-bcb8-3ec129599d1d"
                }
            ],
            "userId": "u-8f00dfd6-bcc3-5b60-ad3f-f644d51d957e",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-30ecdc8-19d2-40e8-a0b9-e938731997a3",
                    "role": "agent",
                    "groupName": "New Group"
                }
            ],
            "lastOnlineAt": "2023-03-06T05:55:20.658Z",
            "createdAt": "2022-11-07T08:49:51.424Z",
            "updatedAt": "2023-03-06T05:55:20.659Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-b62392d-80c9-4569-9e93-bc286e906647",
            "emailId": "marsh_mellow@domain.com",
            "firstName": "Marsh",
            "lastName": "Mello",
            "nickName": "Marsh",
            "profImage": "no-avatar",
            "skills": [],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-8f00dfd6-bcc3-5b60-ad3f-f644d51d957e"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-8f00dfd6-bcc3-5b60-ad3f-f644d51d957e"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-8f00dfd6-bcc3-5b60-ad3f-f644d51d957e"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Administrator"
        },
        {
            "status": "ACTIVE",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6201eaad257a163e989ad0a4",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "desktopLayouts": [
                {
                    "isDefault": true,
                    "id": "ly-83307ec-0d70-42c7-bd72-7bb36be9587e"
                }
            ],
            "userId": "u-954811d9-92b5-50f5-aa00-b6d6640b4050",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-30ecdc8-19d2-40e8-a0b9-e938731997a3",
                    "role": "agent",
                    "groupName": "New Group"
                }
            ],
            "lastOnlineAt": "2023-03-06T05:55:20.673Z",
            "createdAt": "2022-11-07T08:51:25.625Z",
            "updatedAt": "2023-03-06T05:55:20.673Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-d647ca1-1e2a-4663-8457-32a89ec3132b",
            "emailId": "melody.sunshine@domain.com",
            "firstName": "Melody",
            "lastName": "Sunshine",
            "nickName": "Melody",
            "phoneNumber": "535252345234",
            "profImage": "no-avatar",
            "skills": [],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-954811d9-92b5-50f5-aa00-b6d6640b4050"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-954811d9-92b5-50f5-aa00-b6d6640b4050"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-954811d9-92b5-50f5-aa00-b6d6640b4050"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Administrator"
        }
    ],
    "skip": 0,
    "limit": 10,
    "hasMore": false,
    "totalPages": 1,
    "totalResults": 10
}

Response Body Parameters

Field name Description Example Type and Format
status Validity status of the Agent object “ACTIVE” , “INACTIVE” string – one of a predefined set of values
userId Agent’s ID generated by Kore “u-c8a51563-bae4-5730-bc2e-4a83889892f6” string – prefixed-guid
orgId Organization ID generated by Kore “o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e” string – prefixed-guid
accountId Account ID generated by Kore “6201eaad257a163e989ad095”
agentGroups Groups that the agent is a member of array of agentGroup objects
agentGroups[].groupId Agent group ID “ag-b6a6178-e35e-47cc-9a40-900956c08499” string – prefixed-guid
agentGroups[].accessLevel Obsolete “full” string – one of a predefined set of values
agentGroups[].role Obsolete “manager” string – one of a predefined set of values
agentGroups[].groupName Agent group name “Default Group” string
canSupportChat Can the Agent service conversations from digital channels “true” – without the quotes boolean
maxChatSupport Number of simultaneous chats that Agent can support 5 integer
chatLanguageSupport Languages associated with Agent for chats array of agentLanguage objects
chatLanguageSupport[].isActive Is this Agent-Language association currently active? “true” – without the quotes boolean
chatLanguageSupport[].language Supported language that agents can use on chats “en” 2-char Language codes from ISO 639 set 1
chatLanguageSupport[].proficiency How proficient is the agent in language for chats “expert”, “novice”, “average”, “good” string – one of a predefined set of values
canSupportVoice Can the Agent service voice calls “true” – without the quotes boolean
voiceLanguageSupport Languages associated with Agent for voice calls array of agentLanguage objects
voiceLanguageSupport[].isActive Is this Agent-Language association currently active? “true” – without the quotes boolean
voiceLanguageSupport[].language Supported language that agents can use on voice calls “en” 2-char Language codes from ISO 639 set 1
voiceLanguageSupport[].proficiency How proficient is the agent in language for voice calls “expert”, “novice”, “average”, “good” string – one of a predefined set of values
createdBy ID of the user who created this Agent object “u-c8a51563-bae4-5730-bc2e-4a83889892f6” string – prefixed-guid
onlineStatus Status of this Agent (if this is not a custom status, it is identical to the status type) “Offline” or any other built-in or custom status string – one of a predefined set of values
onlineStatusType Status type of this Agent “OFFLINE”, “AVAILABLE”, “AWAY”, “BUSY” string – one of a predefined set of values
hoursOfOperationId ID of the “hours of operation” object associated with Agent “6201ead21e06473c153c5c98”
roleId The ID of the “role” object associated with the agent “6201eaad257a163e989ad0a4”
createdAt The time at which this agent record was created “2022-02-08T04:00:19.156Z” YYYY-MM-DDTHH24:mm:SSZ
updatedAt The time at which this agent record was last updated “2022-02-08T04:00:19.156Z” YYYY-MM-DDTHH24:mm:SSZ
lastOnlineAt The time at which this agent was last online “2022-02-08T04:00:19.156Z” YYYY-MM-DDTHH24:mm:SSZ
desktopLayouts All desktop layouts for Agent Console associated with the agent array of desktopLayout objects
desktopLayouts[].isDefault Is this desktop layout the default one for Agent? “true” – without the quotes boolean
desktopLayouts[].id The layout ID – generated by Kore “ly-ca5231e-9b44-4b39-ac8d-0b36202a3b8d” string – prefixed-guid
attachmentsEnabled Can this agent attach other files to chat messages? “true” – without the quotes boolean
emojisEnabled Can this agent use emojis to chat messages? “true” – without the quotes boolean
isAccountOwner Is this agent the owner of this account? “true” – without the quotes boolean
sipURI The SIP address of the agent “sip:supportuat94@smartassist-agent-np.kore.ai:5060” SIP URI
id Agent ID for this agent “a-1353078-d362-4d5e-95ed-554056e71750” string – prefixed-guid
emailId email ID of this agent “john.doe@domain.com” string
firstName First Name “John” string
lastName Last Name “Doe” string
nickName Nickname “John” string
phoneNumber Phone number “221421421421” string
profImage File name of the profile image for this agent “no-avatar” file name
skills Skills associated with this agent array of skill objects
skills[].userId “u-c8a51563-bae4-5730-bc2e-4a83889892f6” string – prefixed-guid
skills[].skillId Skill ID in the system “641847bf731b5d4baa2d991f”
skills[].proficiencyLevel Agent’s proficiency in this skill “expert”, “novice”, “average”, “good” string – one of a set of predefined values
skills[].name Skill name “Savings Account” string
skills[].skillGroupId Skill group ID “6201ead21e06473c153c5c97” string – Kore-generated
skills[].skillGroupName Skill group name “Default SkillGroup” string
skills[].skillGroupColor Color by which the skill group is rendered. “#D2000D” HEX code for the color
skills[].id “641847bf731b5d4baa2d991f”
queues Skills associated with this Agent array of skill objects
queues[].id The queue ID “qu-53c78e9-d249-477e-a472-9426e25d6cb4” string – prefixed-guid
queues[].name The queue name “Default Queue” string
queues[].description The queue description “Standard queue when all else fails” string
queues[].agents Association of a queue with this agent array of agent-queue association objects
queues[].agents[].isPreferredAgent Is this agent a preferred agent for this Queue? “true” – without the quotes boolean
queues[].agents[].userId
role Role of this user (Agent) in the Contact Center system “Administrator”, “Supervisor”, “Agent” or any custom role string – one of a set of predefined values

List All Agents

To retrieve the list of all agents with the given Stream Id.

Method GET
Endpoint https://{{host}}/agentassist/api/v1/public/{{StreamId}}/agents?page=1&includeQueues=True
Content-Type application/json
Authorization auth: {{JWT}}
See How to generate the JWT Token.
API Scope SmartAssist Analytics

 

Path Parameters

 

Parameter Description Type
host Environment URL, for example, https://smartassist.kore.ai String, Required
BotId BotId or StreamId. You can access it from the General Settings page of the bot. String, Required

 

Query Parameters

Parameter Description Type
page The page number to return. The default is 1. Integer, Optional
includeQueues Whether to include queues in response. Boolean, Optional

 

Sample Request

curl --location 'https://{{host}}/agentassist/api/v1/public/{{StreamId}}/agents?page=1&includeQueues=True' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'
--header 'accountId: {{YOUR_accountId}}'

 

Sample Response

{
    "results": [
        {
            "status": "ACTIVE",
            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "accountId": "6201eaad257a163e989ad095",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "accessLevel": "full",
                    "role": "manager",
                    "groupName": "Default Group"
                },
                {
                    "groupId": "ag-30ecdc8-19d2-40e8-a0b9-e938731997a3",
                    "accessLevel": "full",
                    "role": "manager",
                    "groupName": "New Group"
                }
            ],
            "canSupportChat": true,
            "maxChatSupport": 5,
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": true,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": true,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": true,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": true,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "roleId": "6201eaad257a163e989ad0a4",
            "createdAt": "2022-02-08T04:00:19.156Z",
            "updatedAt": "2023-05-11T07:29:25.278Z",
            "lastOnlineAt": "2023-05-11T07:29:25.278Z",
            "desktopLayouts": [
                {
                    "isDefault": false,
                    "id": "ly-ca5231e-9b44-4b39-ac8d-0b36202a3b8d"
                },
                {
                    "isDefault": true,
                    "id": "ly-92d92b7-4798-419a-a719-07aab1a6ebb1"
                },
                {
                    "isDefault": false,
                    "id": "ly-b0ed0dc-7dec-4d7c-8933-78797a222a4a"
                }
            ],
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "isAccountOwner": true,
            "sipURI": "sip:supportuat94@smartassist-agent-np.kore.ai:5060",
            "id": "a-1353078-d362-4d5e-95ed-554056e71750",
            "emailId": "john.doe@domain.com",
            "firstName": "John",
            "lastName": "Doe",
            "nickName": "John",
            "phoneNumber": "221421421421",
            "profImage": "no-avatar",
            "skills": [
                {
                    "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
                    "skillId": "641847bf731b5d4baa2d991f",
                    "proficiencyLevel": "average",
                    "name": "Blue Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "641847bf731b5d4baa2d991f"
                },
                {
                    "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
                    "skillId": "641847d1731b5d4baa2ded62",
                    "proficiencyLevel": "average",
                    "name": "Red Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "641847d1731b5d4baa2ded62"
                },
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": true,
                            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-c8a51563-bae4-5730-bc2e-4a83889892f6"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Administrator"
        },
        {
            "status": "ACTIVE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "canSupportChat": true,
            "maxChatSupport": 20,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "userId": "u-70b19d34-e795-5059-b687-484c0bc1f795",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "manager",
                    "accessLevel": "view",
                    "groupName": "Default Group"
                }
            ],
            "createdAt": "2022-03-15T12:40:33.177Z",
            "updatedAt": "2023-03-06T05:55:20.517Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "lastOnlineAt": "2023-03-06T05:55:20.517Z",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-898331c-c9e6-4918-9501-6c2626198b32",
            "emailId": "jane.doe@domain.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "nickName": "Jane",
            "phoneNumber": "9000011111",
            "profImage": "no-avatar",
            "skills": [],
            "queues": [
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-70b19d34-e795-5059-b687-484c0bc1f795"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-70b19d34-e795-5059-b687-484c0bc1f795"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "userId": "u-16a7d3ce-1545-51a0-aa34-ce9de87304f2",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "agent",
                    "groupName": "Default Group"
                }
            ],
            "createdAt": "2022-03-22T05:12:26.645Z",
            "updatedAt": "2023-03-06T05:55:20.583Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "lastOnlineAt": "2023-03-06T05:55:20.583Z",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-9c4b773-14ba-4295-8cc1-569036a80b92",
            "emailId": "john.smith@domain.com",
            "firstName": "John",
            "lastName": "Smith",
            "nickName": "John",
            "phoneNumber": "12343112352",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-16a7d3ce-1545-51a0-aa34-ce9de87304f2",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-16a7d3ce-1545-51a0-aa34-ce9de87304f2"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-16a7d3ce-1545-51a0-aa34-ce9de87304f2"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                }
            ],
            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "agent",
                    "groupName": "Default Group"
                }
            ],
            "createdAt": "2022-05-31T12:56:04.376Z",
            "updatedAt": "2023-03-06T05:55:20.610Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "lastOnlineAt": "2023-03-06T05:55:20.610Z",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-397ca96-3c55-4b85-ab36-2b707d243125",
            "emailId": "clark.kent@domain.com",
            "firstName": "Clark",
            "lastName": "Kent",
            "nickName": "Clark",
            "phoneNumber": "9000022222",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-1a97d394-5cba-5c8b-93be-599c548d311b"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "manager",
                    "accessLevel": "full",
                    "groupName": "Default Group"
                }
            ],
            "createdAt": "2022-05-31T14:47:14.819Z",
            "updatedAt": "2023-05-10T16:04:30.609Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "lastOnlineAt": "2023-05-10T16:04:30.608Z",
            "desktopLayouts": [
                {
                    "isDefault": true,
                    "id": "ly-ca5231e-9b44-4b39-ac8d-0b36202a3b8d"
                },
                {
                    "isDefault": false,
                    "id": "ly-4c5be1d-6ca9-49ac-ac54-578e0e097e79"
                },
                {
                    "isDefault": false,
                    "id": "ly-9e304bb-cb55-443e-96ab-14640b754a35"
                }
            ],
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-5978284-a164-41d2-b1d5-b22b1d91ad4d",
            "emailId": "lois.lane@domain.com",
            "firstName": "Lois",
            "lastName": "Lane",
            "nickName": "LLane",
            "phoneNumber": "12353673712",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": true,
                            "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-fd23bb5e-9d3b-50c6-83d0-a73857d9edb7"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "desktopLayouts": [],
            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "agent",
                    "groupName": "Default Group"
                }
            ],
            "lastOnlineAt": "2023-03-06T05:55:20.546Z",
            "createdAt": "2022-10-19T09:34:17.290Z",
            "updatedAt": "2023-03-06T05:55:20.546Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-4088962-3642-40ae-88dc-c578d48c793d",
            "emailId": "henry.higgins@domain.com",
            "firstName": "Henry",
            "lastName": "Higgins",
            "nickName": "Henry",
            "phoneNumber": "121212124151",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575"
                        }
                    ],
                    "name": "Test Queue 6090",
                    "id": "qu-b3b13c5-271a-4599-ab38-9e44acc46989"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-13d6ff42-13ae-5f6c-a430-c46ad25c9575"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6389e47741afba5c08bfd48e",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "desktopLayouts": [
                {
                    "isDefault": false,
                    "id": "ly-9e304bb-cb55-443e-96ab-14640b754a35"
                }
            ],
            "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-30ecdc8-19d2-40e8-a0b9-e938731997a3",
                    "role": "agent",
                    "groupName": "New Group"
                }
            ],
            "lastOnlineAt": "2023-03-06T05:55:20.628Z",
            "createdAt": "2022-11-01T10:49:33.148Z",
            "updatedAt": "2023-03-06T05:55:20.628Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-1aba421-7d05-41a5-a47a-daa450655bb0",
            "emailId": "ann_chovey@domain.com",
            "firstName": "Ann",
            "lastName": "Chovey",
            "nickName": "Ann",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-62ae8e9d-2768-56a3-bc92-7abbc4be949f"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "accountId": "6201eaad257a163e989ad095",
            "agentGroups": [
                {
                    "groupId": "ag-b6a6178-e35e-47cc-9a40-900956c08499",
                    "role": "agent",
                    "groupName": "Default Group"
                }
            ],
            "canSupportChat": true,
            "maxChatSupport": 5,
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                }
            ],
            "createdBy": "u-81191025-27fa-574b-b5ce-f91aa5b47094",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "hoursOfOperationId": "6201ead21e06473c153c5c98",
            "roleId": "6389e47741afba5c08bfd48e",
            "lastOnlineAt": "2023-03-06T05:55:20.644Z",
            "desktopLayouts": [],
            "createdAt": "2022-11-07T08:45:02.797Z",
            "updatedAt": "2023-03-06T05:55:20.644Z",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-e53ad77-1b44-424c-933e-30474ad3d9c6",
            "emailId": "rita_book@domain.com",
            "firstName": "Rita",
            "lastName": "Book",
            "nickName": "Rita",
            "profImage": "no-avatar",
            "skills": [
                {
                    "skillId": "6201ead31e06473c153c5c99",
                    "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094",
                    "proficiencyLevel": "expert",
                    "name": "Default Skill",
                    "skillGroupId": "6201ead21e06473c153c5c97",
                    "skillGroupName": "Default SkillGroup",
                    "skillGroupColor": "#D2000D",
                    "id": "6201ead31e06473c153c5c99"
                }
            ],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-81191025-27fa-574b-b5ce-f91aa5b47094"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Agent"
        },
        {
            "status": "ACTIVE",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6201eaad257a163e989ad0a4",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": false,
            "voiceLanguageSupport": [
                {
                    "isActive": false,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "desktopLayouts": [
                {
                    "isDefault": true,
                    "id": "ly-86ed061-3a2e-4aa0-bcb8-3ec129599d1d"
                }
            ],
            "userId": "u-8f00dfd6-bcc3-5b60-ad3f-f644d51d957e",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-30ecdc8-19d2-40e8-a0b9-e938731997a3",
                    "role": "agent",
                    "groupName": "New Group"
                }
            ],
            "lastOnlineAt": "2023-03-06T05:55:20.658Z",
            "createdAt": "2022-11-07T08:49:51.424Z",
            "updatedAt": "2023-03-06T05:55:20.659Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-b62392d-80c9-4569-9e93-bc286e906647",
            "emailId": "marsh_mellow@domain.com",
            "firstName": "Marsh",
            "lastName": "Mello",
            "nickName": "Marsh",
            "profImage": "no-avatar",
            "skills": [],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-8f00dfd6-bcc3-5b60-ad3f-f644d51d957e"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-8f00dfd6-bcc3-5b60-ad3f-f644d51d957e"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-8f00dfd6-bcc3-5b60-ad3f-f644d51d957e"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Administrator"
        },
        {
            "status": "ACTIVE",
            "canSupportChat": true,
            "maxChatSupport": 5,
            "roleId": "6201eaad257a163e989ad0a4",
            "chatLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "canSupportVoice": true,
            "voiceLanguageSupport": [
                {
                    "isActive": true,
                    "language": "en",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "de",
                    "proficiency": "expert"
                },
                {
                    "isActive": false,
                    "language": "es",
                    "proficiency": "expert"
                }
            ],
            "desktopLayouts": [
                {
                    "isDefault": true,
                    "id": "ly-83307ec-0d70-42c7-bd72-7bb36be9587e"
                }
            ],
            "userId": "u-954811d9-92b5-50f5-aa00-b6d6640b4050",
            "accountId": "6201eaad257a163e989ad095",
            "createdBy": "u-c8a51563-bae4-5730-bc2e-4a83889892f6",
            "orgId": "o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e",
            "agentGroups": [
                {
                    "groupId": "ag-30ecdc8-19d2-40e8-a0b9-e938731997a3",
                    "role": "agent",
                    "groupName": "New Group"
                }
            ],
            "lastOnlineAt": "2023-03-06T05:55:20.673Z",
            "createdAt": "2022-11-07T08:51:25.625Z",
            "updatedAt": "2023-03-06T05:55:20.673Z",
            "onlineStatus": "Offline",
            "onlineStatusType": "OFFLINE",
            "attachmentsEnabled": true,
            "emojisEnabled": true,
            "id": "a-d647ca1-1e2a-4663-8457-32a89ec3132b",
            "emailId": "melody.sunshine@domain.com",
            "firstName": "Melody",
            "lastName": "Sunshine",
            "nickName": "Melody",
            "phoneNumber": "535252345234",
            "profImage": "no-avatar",
            "skills": [],
            "queues": [
                {
                    "name": "Default Queue",
                    "description": "queue description",
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-954811d9-92b5-50f5-aa00-b6d6640b4050"
                        }
                    ],
                    "id": "qu-53c78e9-d249-477e-a472-9426e25d6cb4"
                },
                {
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-954811d9-92b5-50f5-aa00-b6d6640b4050"
                        }
                    ],
                    "name": "Test Queue",
                    "description": "121242",
                    "id": "qu-3066a40-5b85-4ee5-9a8e-6bd800287e3b"
                },
                {
                    "agentGroups": [],
                    "agents": [
                        {
                            "isPreferredAgent": false,
                            "userId": "u-954811d9-92b5-50f5-aa00-b6d6640b4050"
                        }
                    ],
                    "name": "Sample Queue4",
                    "id": "qu-d937893-c788-45d0-9da8-23490287b689"
                }
            ],
            "role": "Administrator"
        }
    ],
    "skip": 0,
    "limit": 10,
    "hasMore": false,
    "totalPages": 1,
    "totalResults": 10
}

Response Body Parameters

Field name Description Example Type and Format
status Validity status of the Agent object “ACTIVE” , “INACTIVE” string – one of a predefined set of values
userId Agent’s ID generated by Kore “u-c8a51563-bae4-5730-bc2e-4a83889892f6” string – prefixed-guid
orgId Organization ID generated by Kore “o-0b9c4fa7-6f16-5605-abb7-62c46bf3994e” string – prefixed-guid
accountId Account ID generated by Kore “6201eaad257a163e989ad095”
agentGroups Groups that the agent is a member of array of agentGroup objects
agentGroups[].groupId Agent group ID “ag-b6a6178-e35e-47cc-9a40-900956c08499” string – prefixed-guid
agentGroups[].accessLevel Obsolete “full” string – one of a predefined set of values
agentGroups[].role Obsolete “manager” string – one of a predefined set of values
agentGroups[].groupName Agent group name “Default Group” string
canSupportChat Can the Agent service conversations from digital channels “true” – without the quotes boolean
maxChatSupport Number of simultaneous chats that Agent can support 5 integer
chatLanguageSupport Languages associated with Agent for chats array of agentLanguage objects
chatLanguageSupport[].isActive Is this Agent-Language association currently active? “true” – without the quotes boolean
chatLanguageSupport[].language Supported language that agents can use on chats “en” 2-char Language codes from ISO 639 set 1
chatLanguageSupport[].proficiency How proficient is the agent in language for chats “expert”, “novice”, “average”, “good” string – one of a predefined set of values
canSupportVoice Can the Agent service voice calls “true” – without the quotes boolean
voiceLanguageSupport Languages associated with Agent for voice calls array of agentLanguage objects
voiceLanguageSupport[].isActive Is this Agent-Language association currently active? “true” – without the quotes boolean
voiceLanguageSupport[].language Supported language that agents can use on voice calls “en” 2-char Language codes from ISO 639 set 1
voiceLanguageSupport[].proficiency How proficient is the agent in language for voice calls “expert”, “novice”, “average”, “good” string – one of a predefined set of values
createdBy ID of the user who created this Agent object “u-c8a51563-bae4-5730-bc2e-4a83889892f6” string – prefixed-guid
onlineStatus Status of this Agent (if this is not a custom status, it is identical to the status type) “Offline” or any other built-in or custom status string – one of a predefined set of values
onlineStatusType Status type of this Agent “OFFLINE”, “AVAILABLE”, “AWAY”, “BUSY” string – one of a predefined set of values
hoursOfOperationId ID of the “hours of operation” object associated with Agent “6201ead21e06473c153c5c98”
roleId The ID of the “role” object associated with the agent “6201eaad257a163e989ad0a4”
createdAt The time at which this agent record was created “2022-02-08T04:00:19.156Z” YYYY-MM-DDTHH24:mm:SSZ
updatedAt The time at which this agent record was last updated “2022-02-08T04:00:19.156Z” YYYY-MM-DDTHH24:mm:SSZ
lastOnlineAt The time at which this agent was last online “2022-02-08T04:00:19.156Z” YYYY-MM-DDTHH24:mm:SSZ
desktopLayouts All desktop layouts for Agent Console associated with the agent array of desktopLayout objects
desktopLayouts[].isDefault Is this desktop layout the default one for Agent? “true” – without the quotes boolean
desktopLayouts[].id The layout ID – generated by Kore “ly-ca5231e-9b44-4b39-ac8d-0b36202a3b8d” string – prefixed-guid
attachmentsEnabled Can this agent attach other files to chat messages? “true” – without the quotes boolean
emojisEnabled Can this agent use emojis to chat messages? “true” – without the quotes boolean
isAccountOwner Is this agent the owner of this account? “true” – without the quotes boolean
sipURI The SIP address of the agent “sip:supportuat94@smartassist-agent-np.kore.ai:5060” SIP URI
id Agent ID for this agent “a-1353078-d362-4d5e-95ed-554056e71750” string – prefixed-guid
emailId email ID of this agent “john.doe@domain.com” string
firstName First Name “John” string
lastName Last Name “Doe” string
nickName Nickname “John” string
phoneNumber Phone number “221421421421” string
profImage File name of the profile image for this agent “no-avatar” file name
skills Skills associated with this agent array of skill objects
skills[].userId “u-c8a51563-bae4-5730-bc2e-4a83889892f6” string – prefixed-guid
skills[].skillId Skill ID in the system “641847bf731b5d4baa2d991f”
skills[].proficiencyLevel Agent’s proficiency in this skill “expert”, “novice”, “average”, “good” string – one of a set of predefined values
skills[].name Skill name “Savings Account” string
skills[].skillGroupId Skill group ID “6201ead21e06473c153c5c97” string – Kore-generated
skills[].skillGroupName Skill group name “Default SkillGroup” string
skills[].skillGroupColor Color by which the skill group is rendered. “#D2000D” HEX code for the color
skills[].id “641847bf731b5d4baa2d991f”
queues Skills associated with this Agent array of skill objects
queues[].id The queue ID “qu-53c78e9-d249-477e-a472-9426e25d6cb4” string – prefixed-guid
queues[].name The queue name “Default Queue” string
queues[].description The queue description “Standard queue when all else fails” string
queues[].agents Association of a queue with this agent array of agent-queue association objects
queues[].agents[].isPreferredAgent Is this agent a preferred agent for this Queue? “true” – without the quotes boolean
queues[].agents[].userId
role Role of this user (Agent) in the Contact Center system “Administrator”, “Supervisor”, “Agent” or any custom role string – one of a set of predefined values