Skip to main content
POST
Get agent
Required scopes: agents--my:ro, agents--all:ro

Authorizations

Authorization
string
header
required

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

application/json
id
string
required

The agent ID.

fields
enum<string>[]

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 — The list of the agent's active email subscriptions.
  • notifications — The 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 — If true: the agent is suspended.
  • awaiting_approval — If true: the agent is awaiting approval.
  • last_logout — The RFC 3339 date-time of the agent's last logout. Omitted when no logout occurred.
Available options:
work_scheduler,
groups,
email_subscriptions,
notifications,
job_title,
mobile,
max_chats_count,
suspended,
awaiting_approval,
last_logout

Response

200 - application/json

Agent details.

id
string

The agent ID.

account_id
string

Unique identifier of the agent's account.

name
string

The agent name.

avatar
string

The URL of the agent's avatar.

role
enum<string>

The agent role.

Available options:
owner,
viceowner,
administrator,
normal
login_status
enum<string>

The agent's current login status.

Available options:
accepting chats,
not accepting chats
job_title
string

The agent's job title.

mobile
string

The agent's mobile number.

max_chats_count
integer

The agent's maximum number of concurrent chats.

suspended
boolean

If true: the agent is suspended.

awaiting_approval
boolean

If true: the agent is awaiting approval.

last_logout
string

The RFC 3339 date-time of the agent's last logout. Omitted when no logout occurred.

notifications
string[]

Agent notifications that are turned on.

email_subscriptions
string[]

Subscriptions sent to the agent via email.

groups
object[]

Groups the agent belongs to.

work_scheduler
object