Skip to main content
GET
List contacts

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

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