List agents

Agents who can be assigned tickets, with ID, name and role.

GET https://cotlet.dev/api/v1/happyfox/agents

read

Lists the staff in your HappyFox with ID, name and role. Use assignee_id with update_ticket. What your agent user can see depends on its role.

Parameters

Parameters: list_agents
NameTypeDescription
query string string Only agents whose name or email contains this text.

Request

cURL
curl https://cotlet.dev/api/v1/happyfox/agents \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("happyfox", "list_agents")
Node.js
const result = await cotlet.call('happyfox', 'list_agents');
CLI
cotlet call happyfox list_agents

Example response

JSON

{
  "agents": [
    {
      "agent_id": 12,
      "name": "Sam Okafor",
      "role": "Agent"
    },
    {
      "agent_id": 3,
      "name": "Lena Ortiz",
      "role": "Admin"
    }
  ]
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.