Skip to main content
GET
/
{phone_number_id}
/
contacts
/
{wa_id}
Get contact details
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/{phone_number_id}/contacts/{wa_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "wa_id": "15551234567",
  "profile_name": "John Doe",
  "display_name": "John (VIP Customer)",
  "metadata": {
    "customer_tier": "premium",
    "tags": [
      "vip",
      "high-value"
    ],
    "last_order_date": "2024-01-10"
  },
  "created_at": "2024-01-10T08:00:00.000000Z",
  "updated_at": "2024-01-15T12:34:56.123456Z"
}

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

​
wa_id
string
required

WhatsApp ID (phone number)

Query Parameters

​
fields
string

Filter response fields

Response

Successfully retrieved contact

​
id
string
required

Contact ID (UUID)

Example:

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

​
wa_id
string
required

WhatsApp ID (phone number)

Example:

"15551234567"

​
profile_name
string

WhatsApp profile name

Example:

"John Doe"

​
display_name
string

Custom display name

Example:

"John (VIP Customer)"

​
metadata
object | null

Custom metadata

​
created_at
string<date-time>

Contact creation timestamp

Example:

"2024-01-15T12:34:56.123456Z"

​
updated_at
string<date-time>

Last update timestamp

Example:

"2024-01-15T12:34:56.123456Z"