Get Managers
  • 09 Jun 2025
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Get Managers

  • Dark
    Light
  • PDF

Article summary

Get
/managers

This API returns a list of all agents and admins related to the account.
It sends a URL (The specific account Id will be the authentication params) and returns a list of agents/admin found in the account.

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.

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
id
integer

The agent’s or admin’s Id number

Example520760
identityId
integer

CommBox associates conversations with a customer via a specified communication channel. A customer may have a few identities when the conversations use 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 business account number in CommBox

Example223221
permissionId
integer
Example3
firstName
string
ExampleJohn
lastName
string
ExampleSmith
email
string
Examplejohn.s@gmail.com
userName
string
Examplejohn.s
team
integer

List all teams associated with this agents

Example2343,2445,4342
teamId
integer

Id of the first team this agent belonged to

Example2343
teamName
string

The name of the first listed team

ExampleVIP
profiles
string

Profiles Id(s) associated with this agent.

Example234355,24566
maxSyncObjectsAssignments
integer
Example3
maxAsyncObjectsAssignments
integer
Example5
object
object
id
integer
Example520761
identityId
integer
Example2192428
streamProviderId
string
Examplejohn.d@gmail.com
thumbnailUrl
string
Example
brandId
integer
Example2
permissionId
integer
Example3
firstName
string
ExampleJohn
lastName
string
ExampleDoe
email
string
Examplejohn.d@gmail.com
userName
string
Examplejohn.d
teamId
integer
Example0
teamName
string
Example
profiles
string
Example
maxSyncObjectsAssignments
integer
Example2
maxAsyncObjectsAssignments
integer
Example4
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?

What's Next