users
  • 16 Oct 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

users

  • Dark
    Light
  • PDF

Article summary

Get
/api/user_management/v1/users

Returns a list of agents of callcenter based on callcenter's API key.

Header parameters
Authorization: Bearer token
stringRequired
Query parameters
id
integer
Example28982
name
string
ExampleAgent Name
email
string
Exampleagent@email.com
sip_account
string
Exampleag@cc1.email.net
sag
string
ExampleAgent
extension
string
Example2594
caller_id
string
Example378
timezone
string
ExampleIstanbul
Responses
200

Success

Example{ "summary": "Agents parameters", "description": "All of the user data", "value": { "id": 28982, "name": "AG D", "email": "ag@g.com", "sip_account": "ag@cc1.email.net", "sag": "Agent", "extension": 2594, "caller_id": 378, "timezone": "Istanbul", "webrtc_ringtone": null, "assigned_teams": "3623, 2481", "supervisor_in_teams": "Support, Team3", "assigned_skills": [ { "name": "Skill1", "value": 4 } ], "assigned_queues": "AG Queue", "employee_id": 123, "assigned_channels": [ { "type": "WhatsApp", "name": "WhatsApp Support 1", "value": 1234567890 } ] } }
401

Unauthorized

example1

Error1

Invalid API key

{
  "error": "Invalid api_key"
}
Example{ "error": "Invalid api_key" }

Was this article helpful?

What's Next