Skip to main content
Back to API List To retrieve the details of a particular agent with the given botId and agent Id.
MethodGET
Endpointhttps://{{host}}/agentassist/api/v1/public/{{botId}}/agents/{{agentId}}
Content Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token
API ScopeSmartAssist Analytics

Path Parameters

ParameterDescriptionType
hostEnvironment URL, for example, https://platform.kore.aistring, required
botIdbotId or streamId. You can get it from the App Settings page.string, required
agentIdThe Agent Id 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: {{Your_JWT_token}}' \
--header 'accountId: {{accountId}}'

Header Parameters

ParameterDescriptionType
acceptSpecifies the expected response format. Use application/json to receive JSON data.string, required
authJWT token used to authenticate the request.string, required
accountIdUnique 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",
    "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

ParameterDescriptionType
firstNameUser’s first name.string
lastNameUser’s last name.string
fullNameUser’s full name.string
lFullNameUser’s full name in lowercase.string
emailIdUser’s email address.string
nickNameUser’s nickname.string
profImageProfile image identifier.string
phoneNumberUser’s phone number.string
userIdUnique identifier of the user.string
accountIdUnique identifier of the account.string
isAccountOwnerIndicates if the user owns the account.boolean
orgIdUnique identifier of the organization.string
customIdCustom identifier.string
agentGroupsList of agent groups the user belongs to.array(object)
agentGroups.groupIdGroup identifier.string
agentGroups.roleAssigned role in the group.string
agentGroups.nameGroup name.string
canSupportChatIndicates if the user can support chat.boolean
canSupportCaseIndicates if the user can support cases.boolean
maxCaseSupportMaximum case capacity.number
maxTaskSupportMaximum task capacity.number
canSupportVoiceMailIndicates if the user can support voicemail.boolean
maxVoiceMailSupportMaximum voicemail support limit.number
chatLanguageSupportSupported chat languages.array(object)
chatLanguageSupport.languageLanguage code.string
chatLanguageSupport.proficiencyLanguage proficiency.string
chatLanguageSupport.isActiveIndicates if the language is active.boolean
caseLanguageSupportSupported case languages.array(object)
canSupportVoiceIndicates if the user can support voice.boolean
voiceLanguageSupportSupported voice languages.array(object)
maxDigitalConvoLimitMaximum number of digital conversations.number
attachmentsEnabledIndicates if attachments are enabled.boolean
emojisEnabledIndicates if emojis are enabled.boolean
createdByUser who created this user record.string
statusUser status.string
roleIdAssigned role identifier.string
iIdInternal identifier.string
desktopLayoutsAssigned desktop layouts.array(object)
desktopLayouts.idLayout ID.string
desktopLayouts.isDefaultIndicates if the layout is default.boolean
cmLayoutsCase-management layouts.array
voiceSupportVoice support configuration.array(object)
voiceSupport.typeVoice support type.string
voiceSupport.isEnabledIndicates if the voice support type is enabled.boolean
maxDigitalChatSupportMaximum digital chat limit.number
maxEmailChatSupportMaximum email chat limit.number
maxMessagingChatSupportMaximum messaging chat limit.number
markedAutoAwayIndicates if the system marked the user as away.boolean
dAgentGroupsAdditional dynamic agent groups.array
lastOnlineAtTimestamp of last online activity.string (ISO datetime)
createdAtUser creation timestamp.string (ISO datetime)
updatedAtUser update timestamp.string (ISO datetime)
onlineStatusUser’s online status.string
onlineStatusTypeOnline status type.string
sipURISIP URI assigned to the agent.string
isChannelUpdatedByAgentIndicates if the agent updated the channel.boolean
profImageUrlURL of the profile image.string
idUnique internal identifier.string
nameDisplay name.string
addressesWebSocket server addresses.array(string)
iceServersICE server list for voice/WebRTC.array(object)
iceServers.urlServer URL.string
iceServers.urlsServer URLs.string
iceServers.usernameUsername for TURN server.string
iceServers.credentialCredential for TURN server.string
domainSIP/WebRTC domain.string
preferencesUser preferences.object
preferences.themePreferred UI theme.string
roleUser’s functional role.string
skillsAssigned skills.array
queuesAssigned queues.array
internalChatPermissionIndicates if internal chat is allowed.boolean
callRegionRegion used for voice routing.string