Get User
- 09 Jun 2025
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Get User
- Updated on 09 Jun 2025
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/users/{USER_ID}
Get user information
In order to get data, must use either UserId 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_ID
Required
User ID. This is a commbox generated number
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)
Responses
200
OK
object
status
string
Example200
description
string
ExampleOperation successful
response_time
string
Example2024-08-06T07:51:52.2581942Z
data
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{}
permissionId
integer
Example1
numIdentities
integer
Example2
numObjects
integer
Example0
locale
string
Exampleen_US
remarks
string
Exampletest remark..
userTags
string
Example[{"id":1007,"name":"test","group_name":null}]
teamId
integer
Example0
identities
Array
OneOf
object
object
id
integer
Example1957166
userId
integer
Example1769668
numObjects
integer
Example0
userName
string
Example
streamProviderEmail
string
Exampleredlich@appnext.com
streamProviderId
string
Exampleredlich@appnext.com
streamProviderType
integer
Example4
firstName
string
ExampleBob
lastName
string
ExampleCohen
thumbnailUrl
string
Example
content
string
Example{}
object
object
id
integer
Example2158778
userId
integer
Example1769668
numObjects
integer
Example0
userName
string
Example
streamProviderEmail
string
Examplebob.c100@gmail.com
streamProviderId
string
Example972547724967
streamProviderType
integer
Example5
firstName
string
ExampleBob
lastName
string
ExampleCohen
thumbnailUrl
string
Example
content
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?
