List conversations

List 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": "[email protected]",
          "distinctId": "user_12345",
          "attributes": {
            "planType": "premium"
          }
        },
        "agent": {
          "id": "agent_1234567890",
          "name": "Jane Smith",
          "email": "[email protected]",
          "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
    }
  }
}

GET

api

conversations

List 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": "[email protected]",
          "distinctId": "user_12345",
          "attributes": {
            "planType": "premium"
          }
        },
        "agent": {
          "id": "agent_1234567890",
          "name": "Jane Smith",
          "email": "[email protected]",
          "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<int64>

Filter by start date as Unix timestamp in seconds

Example:

1747196400

endDate

integer<int64>

Filter by end date as Unix timestamp in seconds

Example:

1747200000

Response

Successfully retrieved conversations list

status

string

Example:

"success"

data

object

Show child attributes

data.conversations

object[]

Show child attributes

data.conversations.id

string

Example:

"chat_1234567890"

data.conversations.isResolved

boolean

Example:

false

data.conversations.isStarred

boolean

Example:

false

data.conversations.isMuted

boolean

Example:

false

data.conversations.isAgent

boolean

Example:

false

data.conversations.integrationType

enum<string>

Available options:

WHATSAPP,

SLACK

Example:

"WHATSAPP"

data.conversations.contact

object

Show child attributes

data.conversations.contact.id

string

Example:

"contact_1234567890"

data.conversations.contact.name

string

Example:

"John Doe"

data.conversations.contact.phone

string

Example:

"+1234567890"

data.conversations.contact.email

string

Example:

"[email protected]"

data.conversations.contact.distinctId

string

Example:

"user_12345"

data.conversations.contact.attributes

object

Example:

{ "planType": "premium" }

data.conversations.agent

object

Show child attributes

data.conversations.agent.id

string

Example:

"agent_1234567890"

data.conversations.agent.name

string

Example:

"Jane Smith"

data.conversations.agent.email

string

Example:

"[email protected]"

data.conversations.agent.avatar

string

Example:

"https://example.com/avatar.jpg"

data.conversations.lastMessageDate

string<date-time>

Example:

"2024-01-20T14:45:00Z"

data.conversations.createdAt

string<date-time>

Example:

"2024-01-15T10:30:00Z"

data.conversations.updatedAt

string<date-time>

Example:

"2024-01-20T14:45:00Z"

data.meta

object

Show child attributes

data.meta.total

integer

Total number of conversations

Example:

150

data.meta.perPage

integer

Number of records per page

Example:

20

data.meta.currentPage

integer

Current page number

Example:

1

data.meta.totalPages

integer

Total number of pages

Example:

8

Delete an agent Send a message

⌘I

API v2 Documentation

Agents

Conversations

Contacts

Data Sources

Analytics

Authorizations

Query Parameters

Response