List agents
Returns all agents within a license.
agents--all:roAuthorizations
Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.
Body
The filters to apply to the agent list.
Additional agent fields to include in the response.
work_scheduler— The work scheduler object for the agent.groups— The groups the agent belongs to.email_subscriptions— A list of the agent's active email subscriptions.notifications— A list of the agent's enabled notifications.job_title— The agent's job title.mobile— The agent's mobile number.max_chats_count— The agent's maximum number of concurrent chats.suspended— Iftrue: the agent is suspended.awaiting_approval— Iftrue: the agent is awaiting approval.last_logout— The RFC 3339 date-time of the agent's last logout. Omitted when no logout occurred.
work_scheduler, groups, email_subscriptions, notifications, job_title, mobile, max_chats_count, suspended, awaiting_approval, last_logout Response
A list of agents.
The agent ID.
Unique identifier of the agent's account.
The agent name.
The path to the agent's avatar.
The agent role.
owner, viceowner, administrator, normal The agent's current login status.
accepting chats, not accepting chats The agent's job title.
The agent's mobile number.
The agent's maximum number of concurrent chats.
Email summary subscriptions active for the agent.
If true: the agent is suspended.
If true: the agent is awaiting approval.
The RFC 3339 date-time of the agent's last logout. Omitted when no logout occurred.
Agent notifications that are enabled.
Subscriptions sent to the agent via email.
Groups the agent belongs to.