Skip to main content
GET
/
api
/
v2
/
contacts
List contacts
curl --request GET \
  --url https://app.livechatai.com/api/v2/contacts \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "agentId": "clx1234567890abcdef",
  "data": [
    {
      "id": "contact_1234567890",
      "distinctId": "user_12345",
      "name": "John Doe",
      "email": "[email protected]",
      "phone": "+1234567890",
      "country": "US",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "totalCount": 150,
  "pages": {
    "page": 1,
    "perPage": 10,
    "totalPages": 15,
    "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

​
agentId
string
required

Unique identifier of the agent

Example:

"clx1234567890abcdef"

​
page
integer

Page number for pagination (default: 1)

Required range: x >= 1
Example:

1

​
limit
integer

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

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

10

Response

Successfully retrieved contacts list

​
status
string
Example:

"success"

​
agentId
string
Example:

"clx1234567890abcdef"

​
data
object[]
​
totalCount
integer

Total number of contacts across all pages

Example:

150

​
pages
object