Skip to main content
GET
Get contact details

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 Integrations > 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 | null

WhatsApp ID (phone number). Can be null when Meta only provides BSUID-based 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"

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.123Z"

updated_at
string<date-time>

Last update timestamp

Example:

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