Get User Objects

  • Published on Feb 12, 2026
  • 2 minute(s) read
  • EM
 Prev Next
Get
/v2/users/identities/{USER_IDENTITY_ID}/objects

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.

Security
HTTP
Type bearer

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.

Path parameters
USER_IDENTITY_ID
integer (int64) Required

Only return objects created by this user

Responses
200

OK

Expand All
object
totalUnreadChatMessages
integer

Total count of unread chat messages across all conversations

Example2
status
integer
Example200
description
string
ExampleOperation successful
response_time
string (date-time)
Example2026-02-12T15:09:23.998Z
data
Array of object
object
objectId
integer
Example396001
streamId
integer
Example19155
subStreamId
integer
Example0
streamProviderId
string
Example
streamProviderType
integer
Example0
user_identity
integer
Example558355
firstName
string
Example
lastName
string
Example
moduleId
integer
Example0
userStreamProviderId
string
Exampled7655a64-ac14-4aa1-8907-1e26402ac6da
userStreamProviderType
integer
Example6
content
string
Example{"guidRT":"d34f89f73ffb4ec9909b7da1964cb7cb","languages":[{"Item1":"en","Item2":1471163}]}
message
string
Example<p><span style="letter-spacing: 0.36px">What is your ID number?&nbsp;</span></p>
createdTime
string (date-time)
Example2026-02-12T15:01:02Z
updatedTime
string (date-time)
Example2026-02-12T15:08:16Z
closedTime
string (date-time) | null
Example
firstResponseTime
string (date-time)
Example2026-02-12T15:01:27Z
lastResponseTime
string (date-time)
Example2026-02-12T15:09:13Z
statusId
integer
Example1
assignedManagerId
integer
Example0
lastAssignedManagerId
integer
Example0
type
integer
Example0
user
object
id
integer
Example545516
managerId
integer | null
Example
isManager
boolean
Examplefalse
encryptedId
string | null
Example
identity
object | null
Example
uniqueId
string
Example
phone1
string
Example
phone2
string
Example
email
string
Example
firstName
string
Example
lastName
string
Example
gender
string
Example
numberIdentities
integer
Example1
locale
string
Example
birthday
string
Example
remarks
string
Example
content
string
Example{}
isManager
boolean
Examplefalse
childs
Array of object
object
id
integer
Example1471164
objectId
integer
Example396001
content
string
Example{"messageAlreadyRenderedFromClient":true}
message
string
ExampleHi, How can I help you?
createdTime
string (date-time)
Example2026-02-12T15:00:57Z
streamProviderType
integer
Example0
type
integer
Example11
user
object
id
integer
Example545437
managerId
integer
Example545437
isManager
boolean
Exampletrue
encryptedId
string
ExampleHnJymfEHh8dORgiV0otwEgRpcFYJqKfueiQqPvbZTrs%3d
identity
object
id
integer
Example558237
streamProviderId
string
Example
streamProviderType
integer
Example0
firstName
string
ExampleAI Agent
lastName
string
Example
thumbnailUrl
string
Example
uniqueId
string | null
Example
phone1
string | null
Example
phone2
string | null
Example
email
string | null
Example
firstName
string | null
Example
lastName
string | null
Example
gender
string | null
Example
numberIdentities
integer
Example0
locale
string | null
Example
birthday
string | null
Example
remarks
string | null
Example
content
string | null
Example
activityLogs
Array of object
Example[]
object
tagsObjectId
Array of integer
Example[]
integer
customerParticipants
Array of object
Example[]
object
unreadMessages
integer

Count of unread messages for this specific conversation

Example2
400

Bad Request - The request could not be understood by the server. Incoming parameters might not be valid

object
status
integer
Example400
description
string
ExampleBad Request
response_time
string (date-time)
401

Unauthorized - The supplied credentials, if any, are not sufficient to access the resource

object
status
integer
Example401
description
string
ExampleUnauthorized access
response_time
string (date-time)
404

Not Found - The requested resource is not found

object
status
integer
Example404
description
string
ExampleNot found
response_time
string (date-time)
429

Too Many Requests - Too many requests have been made in a short period of time (Throttling)

object
status
integer
Example429
description
string
ExampleToo Many Requests
response_time
string (date-time)
500

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"
}
object
status
integer
Example500
description
string
ExampleOperation failed
response_time
string (date-time)
501

Not Implemented - The requested operation is not supported

object
status
integer
Example501
description
string
ExampleNot Implemented
response_time
string (date-time)