Skip to main content
GET
/
{phone_number_id}
/
conversations
/
{conversation_id}
Get conversation details
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/conversations/{conversation_id} \
  --header 'X-API-Key: <api-key>'
{
  "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"
    ],
    "customer_tier": "premium"
  },
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kapso.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

​
conversation_id
string
required

Conversation ID

Query Parameters

​
fields
string

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

Response

Successfully retrieved conversation

​
id
string
required

Conversation ID (UUID)

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
status
enum<string>
required

Conversation status

Available options:
active,
ended
Example:

"active"

​
last_active_at
string<date-time>
required

Last activity timestamp

Example:

"2024-01-15T14:30:00.000000Z"

​
created_at
string<date-time>
required

Creation timestamp

Example:

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

​
updated_at
string<date-time>
required

Last update timestamp

Example:

"2024-01-15T14:30:00.000000Z"

​
whatsapp_config_id
string
required

WhatsApp configuration ID (UUID)

Example:

"456e7890-a12b-34c5-d678-901234567890"

​
phone_number_id
string
required

WhatsApp Business Phone Number ID

Example:

"110987654321"

​
phone_number
string | null

Contact's phone number (normalized). Can be null for BSUID-only identity.

Example:

"15551234567"

​
business_scoped_user_id
string | null

WhatsApp business-scoped user ID

Example:

"US.13491208655302741918"

​
parent_business_scoped_user_id
string | null

Parent business-scoped user ID when provided by Meta

Example:

"US.ENT.506847293015824"

​
username
string | null

WhatsApp username when available

Example:

"@testusername"

​
metadata
object

Custom metadata

​
kapso
object

Kapso-specific conversation metadata