Skip to main content
GET
/
v1
/
conversations
List conversations
curl --request GET \
  --url https://app.chatbotx.io/api/v1/conversations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "botEnabled": true,
      "botResumeAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "additionalAttributes": "<string>",
      "contactLastReadAt": "2023-11-07T05:31:56Z",
      "agentLastReadAt": "2023-11-07T05:31:56Z",
      "lastActivityAt": "2023-11-07T05:31:56Z",
      "followed": true,
      "workspaceId": "<string>",
      "contactId": "<string>",
      "adminRepliedAt": "2023-11-07T05:31:56Z",
      "contactRepliedAt": "2023-11-07T05:31:56Z",
      "contactInboxes": [
        {
          "id": "<string>",
          "contactId": "<string>",
          "inboxId": "<string>",
          "channel": "<string>"
        }
      ],
      "messages": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "conversationId": "<string>",
          "contactInboxId": "<string>",
          "workspaceId": "<string>",
          "text": "<string>",
          "contentAttributes": "<string>",
          "sourceId": "<string>",
          "senderId": null,
          "clientId": "<string>"
        }
      ],
      "contact": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "avatar": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "emailVerified": true,
        "emailOptIn": true,
        "firstName": "<string>",
        "lastName": "<string>",
        "fullName": "<string>",
        "lastReadAt": "2023-11-07T05:31:56Z",
        "ref": "<string>",
        "country": "<string>",
        "state": "<string>",
        "city": "<string>",
        "location": "<string>",
        "locale": "<string>",
        "timezone": "<string>",
        "subscribedAt": "2023-11-07T05:31:56Z",
        "broadcastSubscribedAt": "2023-11-07T05:31:56Z",
        "blockedAt": "2023-11-07T05:31:56Z",
        "workspaceId": "<string>"
      },
      "assignedUser": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "email": "<string>",
        "emailVerified": true,
        "image": "<string>",
        "isAnonymous": true
      },
      "assignedInboxTeam": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "workspaceId": "<string>",
        "name": "<string>"
      },
      "aiContextLastMessageId": null,
      "assignedUserId": null,
      "assignedInboxTeamId": null
    }
  ],
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
botCategory
enum<string>
Available options:
bot,
human,
all
​
assignedId
string | null
​
channel
enum<string>
Available options:
omnichannel,
webchat,
messenger,
whatsapp,
zalo,
smtp,
telegram,
instagram,
tiktok
​
status
enum<string>[]
Available options:
noAdminReply,
unread,
followUp,
archived,
blocked
​
keyword
string
​
botEnabled
boolean | null
​
tags
enum<string>[]
Available options:
noAdminReply,
unread,
followUp,
archived,
blocked
​
contactFilter
object
​
cursor
string
​
perPage
integer | null
Required range: 1 <= x <= 9007199254740991
​
sort
object[] | null

Response

200 - application/json

OK

​
data
object[]
required
​
nextCursor
string | null
required
​
prevCursor
string | null
required