List agents
Agents of the account with role, group and current status.
GET https://cotlet.dev/api/v1/freshchat/agents
read
Returns the agents you can assign conversations to, each with the agent_id other tools take, the role, the groups they belong to and the status they set in Freshchat. Freshchat's default statuses are "Active on IntelliAssign" and "Unavailable", and an Admin can add custom ones. Use group_id to list one team.
Parameters
| Name | Type | Description |
|---|---|---|
| group_id string | string | Only agents of this group, from list_groups. |
Request
curl https://cotlet.dev/api/v1/freshchat/agents \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("freshchat", "list_agents")const result = await cotlet.call('freshchat', 'list_agents');cotlet call freshchat list_agentsExample response
{
"agents": [
{
"agent_id": "2f8a1c3e-9b47-4d60-a5e2-7c1d0b9f3a45",
"name": "Dana Reed",
"role": "Agent",
"groups": [
"Support"
],
"status": "Active on IntelliAssign"
},
{
"agent_id": "9d4b6e21-0a3c-47f8-b1e5-3a6c8d2f1b70",
"name": "Marcus Hale",
"role": "Admin",
"groups": [
"Billing"
],
"status": "In a Meeting"
}
]
}