Get Manager
- 09 Jun 2025
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Get Manager
- 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
/managers/{MANAGER_ID}
This API returns information about a specific agent or an administrator based on the manager Id (required).
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
MANAGER_ID
Required
Manager ID. This is a commbox generated number
Responses
200
OK
object
status
string
Example200
description
string
ExampleOperation successful
response_time
string
Example2024-08-06T07:51:52.2581942Z
data
object
id
integer
The manager’s id number
Example520760
content
string
Lists related statuses about the agent/admin: Active state – shows the user’s status, Password verification, Email verification, Chosen color
Example{"user_color":"","_isEmailVerified":true,"_activationState":"Handled"}
identityId
integer
CommBox associates conversations with a customer via a specified communication channel. A customer may have a few identities when the conversation is using more than one communication channel. For agents/admins, this number is irrelevant and just identifies the user as a Manager.
Example2192427
streamProviderId
string
Access point – usually the email
Examplejohn.s@gmail.com
thumbnailUrl
string
If the agent/admin has an associated thumbnail picture, the URL to the file will be listed here.
Example
brandId
integer
The CommBox account number associated with this agent/admin
Example1054
permissionId
integer
Admins will have 3. Agents may have any other number (usually 2)
Example3
firstName
string
ExampleJohn
lastName
string
ExampleSmith
email
string
Examplejohn.s@gmail.com
userName
string
Examplejohn.s
teamId
integer
Lists the teams’ Id associated with the agent/admin
Example431
teamName
string
ExampleVIP
profiles
string
List profiles Id associated with the agent/admin
Example
maxSyncObjectsAssignments
integer
States the maximum number of Synchronous conversations the agent allows to have (Admins or agents without limitations will be null). Edit in the Auto Assignment module or in the Status tab of the Users page.
Example3
maxAsyncObjectsAssignments
integer
States the maximum number of Asynchronous conversations the agent allows to have (Admins or agents without limitations will be null). Edit in the Auto Assignment module or in the Status tab of the Users page.
Example5
multiReplyAccess
string
Related to profiles
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?
