Sign in

v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB
Chats

Fetch chat list (inbox)

Retrieve the chat list (inbox) for the authenticated org/user, with optional filtering and cursor-based pagination.

get/chats

Query parameters

limitnumber
Example:10

Number of chats to return. Min 1, max 100. Defaults to 10.

status'all' | 'unread' | 'unresolved' | 'done' | 'waiting_for_response' | 'open' | 'open_cart'
Example:unresolved

Filter chats by status.

tagsstring
Example:vip,lead

Comma-separated tag names to filter chats.

assignedUserPhonestring
Example:+919999999999

Phone number of the assigned agent (with or without leading +). Use the literal string 'null' to fetch unassigned chats.

wabaNumbersstring
Example:11234567890,19876543210

Comma-separated WhatsApp WABA phone numbers to filter chats. Only applies to WhatsApp chats. Use instagramHandles to filter Instagram chats.

instagramHandlesstring
Example:myaccount,otheraccount

Comma-separated Instagram account handles to filter chats. Accepts handles with or without leading @. Only applies to Instagram chats. Use wabaNumbers to filter WhatsApp chats.

nextChatIdstring

Pagination cursor. Pass the value of paginationOptions.nextChatId from the previous response.

nextChatTimestampnumber
Example:1711929600000

Pagination cursor. Pass the value of paginationOptions.nextChatTimestamp from the previous response (epoch milliseconds).

Response

Success

Example response

{
  "chats": [
    {
      "chatType": "INDIVIDUAL",
      "name": "John Doe",
      "phoneNumber": "919876543210",
      "imageUrl": "https://example.com/profile.jpg",
      "unreadCount": 3,
      "optIn": true,
      "chatUpdatedTime": 1711929600000,
      "lastMessageTime": 1711929600000,
      "wabaNumber": "11234567890",
      "wabaPhoneName": "Support Line",
      "wabaDisplayName": "Acme Support",
      "assignedUserName": "Jane Smith",
      "assignedUserNumber": "919999999999",
      "tagNames": [
        "vip",
        "lead"
      ],
      "customFields": [
        {
          "name": "Country",
          "type": "single_select",
          "value": "India"
        }
      ],
      "eligibleMessageTypes": [
        "ANY"
      ]
    }
  ],
  "paginationOptions": {
    "hasMoreChats": true
  }
}