GET
/
api
/
v2
/
conversations
curl --request GET \
  --url https://app.livechatai.com/api/v2/conversations \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": {
    "conversations": [
      {
        "id": "chat_1234567890",
        "isResolved": false,
        "isStarred": false,
        "isMuted": false,
        "isAgent": false,
        "integrationType": "WHATSAPP",
        "contact": {
          "id": "contact_1234567890",
          "name": "John Doe",
          "phone": "+1234567890",
          "email": "john@example.com",
          "distinctId": "user_12345",
          "attributes": {
            "planType": "premium"
          }
        },
        "agent": {
          "id": "agent_1234567890",
          "name": "Jane Smith",
          "email": "jane@company.com",
          "avatar": "https://example.com/avatar.jpg"
        },
        "lastMessageDate": "2024-01-20T14:45:00Z",
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-20T14:45:00Z"
      }
    ],
    "meta": {
      "total": 150,
      "perPage": 20,
      "currentPage": 1,
      "totalPages": 8
    }
  }
}

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

​
perPage
integer

Number of conversations per page (default: 20, max: 100)

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

20

​
type
enum<string>

Type of conversations to retrieve

Available options:
unassigned,
your-inbox,
all
Example:

"all"

​
sort
enum<string>

Sort order for lastMessageDate (default: desc)

Available options:
asc,
desc
Example:

"desc"

​
status
enum<string>

Filter by conversation status

Available options:
open,
close
Example:

"open"

​
startDate
integer

Filter by start date as Unix timestamp in seconds

Example:

1747196400

​
endDate
integer

Filter by end date as Unix timestamp in seconds

Example:

1747200000

Response

200
application/json

Successfully retrieved conversations list

The response is of type object.