List agents

GET /v1/agents

Returns the members of your workspace who can be assigned chats, by name, and whether each is available now.

Needs chats:write.

Request

curl https://app.soosh.io/v1/agents \
  -H "Authorization: Bearer $SOOSH_API_KEY"

const res = await fetch('https://app.soosh.io/v1/agents', {
  headers: {
    Authorization: `Bearer ${process.env.SOOSH_API_KEY}`,
  },
});
console.log(await res.json());

import os
import requests

res = requests.get(
    "https://app.soosh.io/v1/agents",
    headers={"Authorization": f"Bearer {os.environ['SOOSH_API_KEY']}"},
)
print(res.json())

Response200

{
  "data": [
    {
      "id": "5b1d7d0e-3c2a-4f61-9a0e-6f8f3b2c1d40",
      "name": "Anita Menon",
      "available": true
    },
    {
      "id": "1b3d5f7b-9c1e-4a3c-b5e7-9d1f3b5d7f8a",
      "name": "Ravi Kumar",
      "available": false
    }
  ],
  "next_cursor": null
}

What is returned

Email addresses are never included. The list isn’t paged, so next_cursor is always null.

Returns

200 The agents.

data array of objects

Show 3 child attributesHide child attributes

Each item:

data[].id string · uuid

data[].name string

data[].available boolean

Whether the agent has set themselves as available now.

next_cursor null

Always null, because agents aren’t paged.

Errors

Only the ones every request can get.