List agents
Agents and admins who can be assigned tickets, with role.
GET https://cotlet.dev/api/v1/zendesk/agents
read
Lists agents and admins in your Zendesk with ID, name and role. Light agents and collaborators are left out, because tickets cannot be assigned to them. Use assignee_id with update_ticket.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Only agents whose name or email contains this text. |
Request
curl https://cotlet.dev/api/v1/zendesk/agents \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("zendesk", "list_agents")const result = await cotlet.call('zendesk', 'list_agents');cotlet call zendesk list_agentsExample response
{
"agents": [
{
"user_id": 20118842,
"name": "Sam Okafor",
"role": "agent"
},
{
"user_id": 20118001,
"name": "Lena Ortiz",
"role": "admin"
}
]
}