Get a Specific Agent - Kore.ai Docs

Back to API List To retrieve the details of a particular agent with the given botId and agent Id.

Method	GET
Endpoint	`https://{{host}}/agentassist/api/v1/public/{{botId}}/agents/{{agentId}}`
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://platform.kore.ai`	String, required
`botId`	Bot identifier or Stream identifier. You can get it from the App Settings page.	String, required
`agentId`	The Agent identifier of the particular agent whose details are being retrieved. You can get this from agents GET API.	String, required

Sample Request

curl --location 'https://{{host}}/agentassist/api/v1/public/{{streamId}}/agents/{{agentId}}' \
--header 'accept: application/json' \
--header 'auth: {{JWT_TOKEN}}' \
--header 'accountId: {{accountId}}'

Header Parameters

Parameter	Description	Type
`accept`	Specifies the expected response format. Use application/json to receive JSON data.	String, required
`auth`	JWT token used to authenticate the request.	String, required
`accountId`	Unique identifier of the account associated with the request context.	String, required

Sample Response

{
    "firstName": "John",
    "lastName": "Doe",
    "fullName": "John Doe",
    "lFullName": "JDoe",
    "emailId": "john.doe@example.com",
    "nickName": "",
    "profImage": "no-avatar",
    "IsAgentConsoleLanding": true,
    "phoneNumber": "",
    "userId": "u-a1a49996-1817-5ce8-bf7b-e9a75d47xxxx",
    "accountId": "667e787ac78a65971ba8xxxx",
    "isAccountOwner": false,
    "orgId": "o-ba2d50ac-e797-56f2-abfa-2f2c937dxxxx",
    "customId": "",
    "agentGroups": [
        {
            "groupId": "ag-937a281-0b54-42ea-80b2-ae914c2dxxxx",
            "role": "agent",
            "name": "Default Group"
        }
    ],
    "canSupportChat": true,
    "canSupportCase": false,
    "maxCaseSupport": 0,
    "maxTaskSupport": 0,
    "canSupportVoiceMail": false,
    "maxVoiceMailSupport": 5,
    "chatLanguageSupport": [
        {
            "language": "en",
            "proficiency": "expert",
            "isActive": true
        }
    ],
    "caseLanguageSupport": [
        {
            "language": "en",
            "proficiency": "expert",
            "isActive": true
        }
    ],
    "canSupportVoice": true,
    "voiceLanguageSupport": [
        {
            "language": "en",
            "proficiency": "expert",
            "isActive": true
        }
    ],
    "maxDigitalConvoLimit": 6,
    "attachmentsEnabled": true,
    "emojisEnabled": true,
    "createdBy": "u-e2103f0d-e995-5a58-842a-52f1b7a4xxxx",
    "status": "ACTIVE",
    "roleId": "667e787ac78a65971ba8xxxx",
    "iId": "st-8e86fcaf-1500-5bc1-890b-1a9c493dxxxx",
    "desktopLayouts": [
        {
            "id": "ly-d63aadd-be95-4b02-b40b-6cabe9a3xxxx",
            "isDefault": true
        }
    ],
    "cmLayouts": [],
    "voiceSupport": [
        {
            "type": "campaigns",
            "isEnabled": false
        }
    ],
    "maxDigitalChatSupport": 2,
    "maxEmailChatSupport": 2,
    "maxMessagingChatSupport": 2,
    "markedAutoAway": false,
    "dAgentGroups": [],
    "lastOnlineAt": "2025-11-19T07:02:47.264Z",
    "createdAt": "2025-11-19T07:02:47.241Z",
    "updatedAt": "2025-11-19T07:19:54.470Z",
    "onlineStatus": "Offline",
    "onlineStatusType": "OFFLINE",
    "sipURI": "sip:support_production_a-3aeb689-a8b4-4dca-8954-9705ea04xxxx@unifiedxo-eu-prod-savg.kore.ai:5060",
    "isChannelUpdatedByAgent": false,
    "profImageUrl": "no-avatar",
    "id": "a-3aeb689-a8b4-4dca-8954-9705ea04xxxx",
    "name": "John Doe",
    "addresses": [
        "wss://eu-savg-sbc1.kore.ai:8443",
        "wss://eu-savg-sbc2.kore.ai:8443"
    ],
    "iceServers": [
        {
            "url": "stun:global.stun.twilio.com:3478",
            "urls": "stun:global.stun.twilio.com:3478"
        },
        {
            "credential": "aMFlLMjlOFuTAxlRWYOK25aVXddXOa1zSbBU0jQmxxxx",
            "url": "turn:global.turn.twilio.com:3478?transport=udp",
            "urls": "turn:global.turn.twilio.com:3478?transport=udp",
            "username": "87f6e016bdff9d4ef869729a1783f65ed4d0e197ff3dd53d149d39cf4e3cxxxx"
        }
    ],
    "domain": "example.com",
    "preferences": {
        "theme": "light"
    },
    "role": "Agent",
    "skills": [],
    "queues": [],
    "internalChatPermission": true,
    "callRegion": "DE"
}

Response Body Parameters

Parameter	Type	Description
`firstName`	String	First name of the agent.
`lastName`	String	Last name of the agent.
`fullName`	String	Full name of the agent.
`lFullName`	String	Short or abbreviated name of the agent.
`emailId`	String	Email address of the agent.
`nickName`	String	Nickname of the agent.
`profImage`	String	Profile image identifier or URL.
`IsAgentConsoleLanding`	Boolean	Indicates whether the Agent Console is the landing page.
`phoneNumber`	String	Phone number of the agent.
`userId`	String	Unique identifier of the user.
`accountId`	String	Unique identifier of the account.
`isAccountOwner`	Boolean	Indicates whether the user is the account owner.
`orgId`	String	Unique identifier of the organization.
`customId`	String	Custom identifier associated with the agent.
`agentGroups`	Array	Groups assigned to the agent.
`agentGroups.groupId`	String	Unique identifier of the agent group.
`agentGroups.role`	String	Role of the agent within the group.
`agentGroups.name`	String	Name of the agent group.
`canSupportChat`	Boolean	Indicates whether the agent can support chat conversations.
`canSupportCase`	Boolean	Indicates whether the agent can support cases.
`maxCaseSupport`	Integer	Maximum number of cases the agent can support.
`maxTaskSupport`	Integer	Maximum number of tasks the agent can support.
`canSupportVoiceMail`	Boolean	Indicates whether the agent can support voice mail.
`maxVoiceMailSupport`	Integer	Maximum number of voice mail interactions the agent can support.
`chatLanguageSupport`	Array	Languages supported by the agent for chat.
`chatLanguageSupport.language`	String	Language code supported for chat.
`chatLanguageSupport.proficiency`	String	Agent’s proficiency level in the chat language.
`chatLanguageSupport.isActive`	Boolean	Indicates whether the language support is active.
`caseLanguageSupport`	Array	Languages supported by the agent for cases.
`caseLanguageSupport.language`	String	Language code supported for cases.
`caseLanguageSupport.proficiency`	String	Agent’s proficiency level in the case language.
`caseLanguageSupport.isActive`	Boolean	Indicates whether the language support is active.
`canSupportVoice`	Boolean	Indicates whether the agent can support voice interactions.
`voiceLanguageSupport`	Array	Languages supported by the agent for voice interactions.
`voiceLanguageSupport.language`	String	Language code supported for voice interactions.
`voiceLanguageSupport.proficiency`	String	Agent’s proficiency level in the voice language.
`voiceLanguageSupport.isActive`	Boolean	Indicates whether the language support is active.
`maxDigitalConvoLimit`	Integer	Maximum number of digital conversations the agent can handle.
`attachmentsEnabled`	Boolean	Indicates whether attachments are enabled for the agent.
`emojisEnabled`	Boolean	Indicates whether emojis are enabled for the agent.
`createdBy`	String	Unique identifier of the user who created the agent.
`status`	String	Current status of the agent.
`roleId`	String	Unique identifier of the agent’s role.
`iId`	String	Unique identifier of the instance.
`desktopLayouts`	Array	Desktop layouts assigned to the agent.
`desktopLayouts.id`	String	Unique identifier of the desktop layout.
`desktopLayouts.isDefault`	Boolean	Indicates whether the layout is the default layout.
`cmLayouts`	Array	Case management layouts assigned to the agent.
`voiceSupport`	Array	Voice support configurations for the agent.
`voiceSupport.type`	String	Type of voice support configuration.
`voiceSupport.isEnabled`	Boolean	Indicates whether the voice support configuration is enabled.
`maxDigitalChatSupport`	Integer	Maximum number of digital chat interactions the agent can support.
`maxEmailChatSupport`	Integer	Maximum number of email chat interactions the agent can support.
`maxMessagingChatSupport`	Integer	Maximum number of messaging chat interactions the agent can support.
`markedAutoAway`	Boolean	Indicates whether the agent is marked as automatically away.
`dAgentGroups`	Array	Additional agent groups assigned to the agent.
`lastOnlineAt`	String	Date and time when the agent was last online in ISO 8601 format.
`createdAt`	String	Date and time when the agent record was created in ISO 8601 format.
`updatedAt`	String	Date and time when the agent record was last updated in ISO 8601 format.
`onlineStatus`	String	Current online status of the agent.
`onlineStatusType`	String	Type of the agent’s online status.
`sipURI`	String	SIP URI used for voice communication.
`isChannelUpdatedByAgent`	Boolean	Indicates whether the channel was updated by the agent.
`profImageUrl`	String	URL or identifier of the agent’s profile image.
`id`	String	Unique identifier of the agent.
`name`	String	Display name of the agent.
`addresses`	Array	WebSocket addresses used for communication.
`iceServers`	Array	ICE servers used for WebRTC communication.
`iceServers.url`	String	URL of the ICE server.
`iceServers.urls`	String	URL or URLs of the ICE server.
`iceServers.credential`	String	Credential used to authenticate with the TURN server.
`iceServers.username`	String	Username used to authenticate with the TURN server.
`domain`	String	Domain associated with the agent.
`preferences`	Object	Agent preferences.
`preferences.theme`	String	Theme configured for the agent.
`role`	String	Role assigned to the agent.
`skills`	Array	Skills assigned to the agent.
`queues`	Array	Queues assigned to the agent.
`internalChatPermission`	Boolean	Indicates whether the agent has permission to use internal chat.
`callRegion`	String	Region associated with voice calls.

​Path Parameters

​Sample Request

​Header Parameters

​Sample Response

​Response Body Parameters

Path Parameters

Sample Request

Header Parameters

Sample Response

Response Body Parameters