Skip to main content
GET
/
{phone_number_id}
/
conversations
List conversations
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/{phone_number_id}/conversations \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "phone_number": "15551234567",
      "status": "active",
      "last_active_at": "2024-01-15T14:30:00.000000Z",
      "created_at": "2024-01-15T10:00:00.000000Z",
      "updated_at": "2024-01-15T14:30:00.000000Z",
      "whatsapp_config_id": "456e7890-a12b-34c5-d678-901234567890",
      "metadata": {
        "tags": [
          "vip",
          "priority"
        ]
      },
      "phone_number_id": "110987654321",
      "kapso": {
        "contact_name": "John Doe",
        "messages_count": 15,
        "last_message_id": "wamid.HBgNMTU1NTE0OTU5Nzg1FQIAERgSMDhGRjdBMDEyOTcxQzFFQkFBAA==",
        "last_message_type": "text",
        "last_message_timestamp": "2024-01-15T14:30:00.000000Z",
        "last_message_text": "Hello! I need help with my order",
        "last_inbound_at": "2024-01-15T14:30:00.000000Z",
        "last_outbound_at": "2024-01-15T14:25:00.000000Z"
      }
    },
    {
      "id": "223e4567-e89b-12d3-a456-426614174001",
      "phone_number": "15559876543",
      "status": "ended",
      "last_active_at": "2024-01-14T12:00:00.000000Z",
      "created_at": "2024-01-14T08:00:00.000000Z",
      "updated_at": "2024-01-14T12:00:00.000000Z",
      "whatsapp_config_id": "456e7890-a12b-34c5-d678-901234567890",
      "metadata": null,
      "phone_number_id": "110987654321",
      "kapso": {
        "contact_name": "Jane Smith",
        "messages_count": 8,
        "last_message_id": "wamid.HBgNMTU1NTE0OTU5Nzg1FQIAERgSMDhGRjdBMDEyOTcxQzFFQkFBAB==",
        "last_message_type": "text",
        "last_message_timestamp": "2024-01-14T12:00:00.000000Z",
        "last_message_text": "Thank you for your help!",
        "last_inbound_at": "2024-01-14T12:00:00.000000Z",
        "last_outbound_at": "2024-01-14T11:58:00.000000Z"
      }
    }
  ],
  "paging": {
    "cursors": {
      "after": "eyJ2YWx1ZXMiOlsiMjAyNC0wMS0xNFQxMjowMDowMC4wMDAwMDBaIiwiMjIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDAxIl0sImNvbHVtbnMiOlsibGFzdF9hY3RpdmVfYXQiLCJpZCJdfQ=="
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Project Settings > API Keys.

Path Parameters

​
phone_number_id
string
required

WhatsApp Business Phone Number ID

Query Parameters

​
status
enum<string>

Filter by conversation status

Available options:
active,
ended
​
last_active_since
string<date-time>

Filter conversations active on or after this time (ISO 8601)

​
last_active_until
string<date-time>

Filter conversations active on or before this time (ISO 8601)

​
phone_number
string

Filter by contact phone number

​
limit
integer
default:20

Maximum number of results per page (default 20, max 100)

Required range: 1 <= x <= 100
​
before
string

Cursor for previous page (Base64 encoded)

​
after
string

Cursor for next page (Base64 encoded)

​
fields
string

Filter response fields. Use kapso() to include Kapso-specific extensions.

Response

Successfully retrieved conversations

​
data
object[]
required
​
paging
object