List agents and groups

List the agents and groups a record can be assigned to.

GET https://cotlet.dev/api/v1/sysaid/agents-and-groups

read

Returns each agent or group with its ID and name, and for groups the agents inside. Which of them can take a record depends on how assignees are configured for your account: a user, a group, or both.

Parameters

Parameters: list_agents_and_groups
NameTypeDescription
kind string string agent or group. Both when left out.
query string string Part of a name to search for.

Request

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

Example response

JSON

{
  "groups": [
    {
      "id": "g332",
      "name": "IT Support",
      "members": [
        "Jordan Reyes",
        "Priya Nair"
      ]
    },
    {
      "id": "g341",
      "name": "Network",
      "members": [
        "Marcus Hill"
      ]
    }
  ],
  "agents": [
    {
      "id": "u2342",
      "name": "Jordan Reyes"
    },
    {
      "id": "u2351",
      "name": "Priya Nair"
    },
    {
      "id": "u2360",
      "name": "Marcus Hill"
    }
  ]
}

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.