This API retrieves conversation objects associated with a specific user identity. In its upgraded V2 version, it also provides the real-time count of unread chat messages for each conversation, enabling organizations to display up-to-date unread message indicators on their websites or applications.
Path param includes the userIdentityId.
Obtain this 'user_identity' value from the Get Object API using the channel and conversation IDs.
API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.
Only return objects created by this user
OK
Successful response with conversation data
{
"totalUnreadChatMessages": 2,
"status": 200,
"description": "Operation successful",
"response_time": "2026-02-12T15:09:23.998Z",
"data": [
{
"objectId": 396001,
"streamId": 19155,
"subStreamId": 0,
"streamProviderId": "",
"streamProviderType": 0,
"user_identity": 558355,
"firstName": "",
"lastName": "",
"moduleId": 0,
"userStreamProviderId": "d7655a64-ac14-4aa1-8907-1e26402ac6da",
"userStreamProviderType": 6,
"content": "{\"guidRT\":\"d34f89f73ffb4ec9909b7da1964cb7cb\",\"languages\":[{\"Item1\":\"en\",\"Item2\":1471163}]}",
"message": "What is your ID number?
",
"createdTime": "2026-02-12T15:01:02Z",
"updatedTime": "2026-02-12T15:08:16Z",
"closedTime": null,
"firstResponseTime": "2026-02-12T15:01:27Z",
"lastResponseTime": "2026-02-12T15:09:13Z",
"statusId": 1,
"assignedManagerId": 0,
"lastAssignedManagerId": 0,
"type": 0,
"user": {
"id": 545516,
"managerId": null,
"isManager": false,
"encryptedId": null,
"identity": null,
"uniqueId": "",
"phone1": "",
"phone2": "",
"email": "",
"firstName": "",
"lastName": "",
"gender": "",
"numberIdentities": 1,
"locale": "",
"birthday": "",
"remarks": "",
"content": "{}"
},
"isManager": false,
"childs": [
{
"id": 1471164,
"objectId": 396001,
"content": "{\"messageAlreadyRenderedFromClient\":true}",
"message": "Hi, How can I help you?",
"createdTime": "2026-02-12T15:00:57Z",
"streamProviderType": 0,
"type": 11,
"user": {
"id": 545437,
"managerId": 545437,
"isManager": true,
"encryptedId": "HnJymfEHh8dORgiV0otwEgRpcFYJqKfueiQqPvbZTrs%3d",
"identity": {
"id": 558237,
"streamProviderId": "",
"streamProviderType": 0,
"firstName": "AI Agent",
"lastName": "",
"thumbnailUrl": ""
},
"uniqueId": null,
"phone1": null,
"phone2": null,
"email": null,
"firstName": null,
"lastName": null,
"gender": null,
"numberIdentities": 0,
"locale": null,
"birthday": null,
"remarks": null,
"content": null
}
}
],
"activityLogs": [],
"tagsObjectId": [],
"customerParticipants": [],
"unreadMessages": 2
}
]
}Total count of unread chat messages across all conversations
User ID. This is a commbox generated number for the customer
User’s unique identifier. This can be an email, social security number or any other type of unique string determined by the brand administrators
User’s phone number (should include country and area code without leading + or 00)
User’s additional phone number (should include country and area code without leading + or 00)
User's Email.
User’s first name
User’s last name
User’s gender (‘M’ for male, ‘F’ for female)
User’s locale
User’s birthday
Number of active identities that are connected to this user
Indicates whether this user is a agent or an admin (true) or a customer (false)
Free text containing general remarks about the user
Identity object that is connected to the user
Count of unread messages for this specific conversation
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
Not Found - The requested resource is not found
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
Internal Server Error - The server could not return the representation due to an internal server error
{
"status": 500,
"description": "Operation failed",
"response_time": "2025-04-15T07:24:52.956Z"
}Not Implemented - The requested operation is not supported