Skip to main content
GET
/
api
/
v1
/
businesses
/
{businessId}
/
agents
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "publicName": "Support Bot",
      "jobTitle": "Customer Support",
      "avatar": "ROBOT",
      "active": true,
      "memoryEnabled": true,
      "contactMemoryEnabled": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

businessId
string<uuid>
required

The business ID

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
active
enum<string>

Filter by active status

Available options:
true,
false
sort
enum<string>
default:-createdAt
Available options:
createdAt,
-createdAt,
publicName,
-publicName

Response

Paginated list of agents

data
object[]
pagination
object