Get contact - Kapso Documentation

GET

contacts

{identifier}

Get contact

curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/contacts/{identifier} \
  --header 'X-API-Key: <api-key>'

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "wa_id": "15551234567",
    "business_scoped_user_id": "US.13491208655302741918",
    "parent_business_scoped_user_id": "US.ENT.506847293015824",
    "username": "@testusername",
    "profile_name": "John Doe",
    "display_name": "John (VIP)",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

identifier

string

required

Contact UUID or WhatsApp phone number

Response

Contact retrieved

data

object

required

Show child attributes

Erase contactPermanently erase a WhatsApp contact and all associated data (conversations, messages, media). The erasure is processed asynchronously. A `204 No Content` response confirms the erasure job was queued. The `identifier` can be the contact UUID or the WhatsApp phone number (E.164 format).

Get contact

curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/contacts/{identifier} \
  --header 'X-API-Key: <api-key>'

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "wa_id": "15551234567",
    "business_scoped_user_id": "US.13491208655302741918",
    "parent_business_scoped_user_id": "US.ENT.506847293015824",
    "username": "@testusername",
    "profile_name": "John Doe",
    "display_name": "John (VIP)",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}