Skip to main content
GET
/
{phone_number_id}
/
contacts
List contacts
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/contacts \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "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"
        ]
      },
      "created_at": "2024-01-10T08:00:00.000000Z",
      "updated_at": "2024-01-15T12:34:56.123456Z"
    },
    {
      "id": "223e4567-e89b-12d3-a456-426614174001",
      "wa_id": "15559876543",
      "profile_name": "Jane Smith",
      "display_name": null,
      "metadata": null,
      "created_at": "2024-01-12T10:00:00.000000Z",
      "updated_at": "2024-01-12T10:00:00.000000Z"
    }
  ],
  "paging": {
    "cursors": {
      "after": "eyJ2YWx1ZXMiOlsiMjAyNC0wMS0xMlQxMDowMDowMC4wMDAwMDBaIiwiMjIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDAxIl0sImNvbHVtbnMiOlsiY3JlYXRlZF9hdCIsImlkIl19"
    }
  }
}

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

​
wa_id
string

Filter by WhatsApp ID (phone number)

​
customer_id
string

Filter by associated customer ID

​
has_customer
boolean

Filter by customer association (true/false)

​
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 contacts

​
data
object[]
required
​
paging
object