Get User Objects
- 09 Jun 2025
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get User Objects
- Updated on 09 Jun 2025
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/users/identities/{USER_IDENTITY_ID}/objects
Get user objects
In order to get data, must use either userIdentityId or both streamProviderId and streamProviderType of the user identity
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
Query parameters
streamProviderId
string
Only return objects created by this user. Represents the user identity. Must supply streamProviderType as well (optional)
streamProviderType
string
Only return objects created by this user. Represents the user identity. Must supply streamProviderId as well (optional)
stream
integer (int64)
The stream Id from which to return objects (optional, default 0)
subStream
integer (int64)
The subchannel Id (Optional, default 0)
pageNumber
integer
Used for paging results (optional)
pageSize
integer
Used for paging results (optional, default 100)
status
string
ObjectStatusType - see Enums for code.
Returned objects must have selected statuses in a comma separated list
(Optional, default all)
order
string
The order to return the objects (optional, default 'closedtime')
objectId
integer (int64)
The object id to filter (optional, default 0)
moduleId
integer (int64)
The module id to filter (optional, default 0)
includeChilds
boolean
Flag to return the object childs (optional, default true)
Exampletrue
includeActivityLog
boolean
Flag to return the object activity log (optional, default false)
Examplefalse
Responses
200
OK
object
status
string
Example200
description
string
ExampleOperation successful
response_time
string
Example2024-08-06T07:51:52.2581942Z
data
Array
OneOf
object
object
objectId
integer
Example1234
streamId
integer
Example4444
subStreamId
integer
Example0
streamProviderId
string
Example11111111_222222
streamProviderType
integer
Example1
user_identity
integer
Example528986
firstName
string
ExampleYuval
lastName
string
ExampleHakim
userStreamProviderId
string
Example972505555555_by
userStreamProviderType
integer
Example4
content
string
Example{"num_likes":5,"user_likes":false,"num_shares":2}
message
string
Examplesome message
createdTime
string
Example2024-08-06T07:51:52.2581942Z
updatedTime
string
Example2024-08-07T06:51:52.2581942Z
closedTime
string
Example2024-08-07T07:51:52.2581942Z
firstResponseTime
string
Example2024-08-06T08:00:52.2581942Z
lastResponseTime
string
Example2024-08-06T08:00:52.2581942Z
statusId
integer
Example1
assignedManagerId
integer
Example0
type
integer
Example0
user
object
id
integer
Example1769668,
firstName
string
ExampleBob
lastName
string
ExampleCohen
gender
string
ExampleMale
phone1
string
Example972547724967
phone2
string
Example
uniqueId
string
Example266684
email
string
Exampleredlich@appnext.com
content
string
Example{}
locale
string
Exampleen_US
remarks
string
Exampletest remark..
birthday
string
Example01/01/1990
numberIdentities
integer
Example3
isManager
boolean
Examplefalse
childs
Array
OneOf
object
object
id
integer
Example123456
object_id
integer
Example1234
content
string
Example{}
message
string
Examplesome message...
createdTime
string
Example2024-08-06T07:51:52.2581942Z
streamProviderType
integer
Example5
user
object
id
integer
Example520760
managerId
integer
Example0
isManager
boolean
Examplefalse
identity
object
id
integer
Example531826
streamProviderId
string
Example972505555555
streamProviderType
integer
Example5
firstName
string
Example
lastName
string
Example
thumbnailUrl
string
Example
object
object
id
integer
Example978944
object_id
integer
Example1234
content
string
Example{}
message
string
Examplesome other message...
createdTime
string
Example2024-08-06T07:55:52.2581942Z
streamProviderType
integer
Example5
user
object
id
integer
Example520803
managerId
integer
Example520803
isManager
boolean
Exampletrue
identity
object
id
integer
Example531811
streamProviderId
string
Examplemichae12@gmail.com
streamProviderType
integer
Example0
firstName
string
Examplemichael
lastName
string
Examplenull
thumbnailUrl
string
Example
400
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
401
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
404
Not found - The requested resource is not found
429
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
500
Server Error - The server could not return the representation due to an internal server error
501
Not Implemented - The requested operation is not supported
Was this article helpful?
