Skip to main content
GET
/
api
/
v2
/
agents
List agents
curl --request GET \
  --url https://app.livechatai.com/api/v2/agents \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": [
    {
      "id": "clx1234567890abcdef",
      "name": "Customer Support Bot",
      "isLiveChatEnabled": true,
      "language": "en",
      "isArchived": false,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:45:00Z"
    }
  ],
  "totalCount": 15,
  "pages": {
    "page": 1,
    "perPage": 10,
    "totalPages": 2,
    "hasPrevious": false,
    "hasNext": true,
    "previous": null,
    "next": 2
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer

Page number for pagination (default: 1)

Required range: x >= 1
Example:

1

​
limit
integer

Number of agents per page (default: 10, max: 100)

Required range: 1 <= x <= 100
Example:

10

Response

Successfully retrieved agents list

​
status
string
Example:

"success"

​
data
object[]
​
totalCount
integer

Total number of agents across all pages

Example:

15

​
pages
object