Get agents

get

https://api.indigitall.com/v2/chat/{applicationId}/contactCenter/agent

Retrieve all agents for the contact center of a given application.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationId

integer

required

Application's ID

Query Params

limit

integer

1 to 200

Defaults to 50

Limit the number of agents returned

page

integer

≥ 0

Defaults to 0

Page number

count

boolean

Defaults to false

Returns the number of agents that match the specified filter criteria.
If set to true, the response will include the count property.
If set to false, the response will only include the data property.

status

string

enum

Filter agents by their status (e.g., online or offline)

Allowed:

connected

boolean

Filter agents by if they are currently connected or not

orderBy

string

enum

Specify the order in which agents are returned.
If set to lastConnectionDesc, agents are ordered by their last connection time in descending order.
If set to statusOnline, agents with status online are returned first, then the rest, with a secondary order by last connection time in descending order.
If set to idDesc or not provided, agents are ordered by their ID in descending order.

Allowed:

nameSearch

string

Filter agents by a search term in their name.

The search is case-insensitive and matches any agent whose name contains the specified term.

countActiveConversations

boolean

Defaults to false

If set to true, the response will include the activeConversations property for each agent, indicating the number of active conversations currently assigned to that agent.
If set to false, the activeConversations property will not be included in the response.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Retrieve information about all agents for a given application

400Bad request

403Forbidden

404Not found

500Internal server error