GET
/
whatsapp_contacts
List WhatsApp contacts
curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_contacts \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "contact-789ghi",
      "wa_id": "1234567890",
      "profile_name": "John Doe",
      "metadata": {},
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "contact-456def",
      "wa_id": "0987654321",
      "profile_name": "Jane Smith",
      "metadata": {},
      "created_at": "2024-01-14T15:45:00Z",
      "updated_at": "2024-01-14T15:45:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "total_count": 2
  }
}

Authorizations

​
X-API-Key
string
header
required

API key required for all endpoints

Query Parameters

​
page
integer
default:1

Page number

​
per_page
integer
default:20

Items per page

​
q[customer_id_eq]
string<uuid>

Filter by exact customer ID match

​
q[customer_external_customer_id_eq]
string

Filter by customer's external ID from your system

​
q[customer_id_null]
boolean

Filter sandbox contacts (contacts with no customer assigned)

​
q[customer_id_not_null]
boolean

Filter contacts with customer assigned (non-sandbox)

​
q[profile_name_cont]
string

Filter by profile name contains (case insensitive partial match)

​
q[wa_id_cont]
string

Filter by phone number contains (partial match)

​
q[created_at_gteq]
string<date-time>

Filter by created date greater than or equal to (ISO 8601 format)

​
q[created_at_lteq]
string<date-time>

Filter by created date less than or equal to (ISO 8601 format)

Response

Successful response

​
data
object[]
​
meta
object