GET
/
whatsapp_conversations
List WhatsApp conversations
curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_conversations \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "conversation-202mno",
      "phone_number": "+1234567890",
      "status": "active",
      "last_active_at": "2023-11-07T05:31:56Z",
      "contact_name": "John Doe",
      "whatsapp_config_id": "config-123abc"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

API key required for all endpoints

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:20
Required range: 1 <= x <= 100
​
q[status_eq]
enum<string>

Filter by exact status match

Available options:
active,
ended
​
q[last_active_at_gteq]
string<date-time>

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

​
q[last_active_at_lteq]
string<date-time>

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

​
q[whatsapp_config_id_eq]
string<uuid>

Filter by exact whatsapp_config_id match

​
q[whatsapp_config_customer_id_eq]
string<uuid>

Filter by customer_id through whatsapp_config relationship

Response

200
application/json

A list of WhatsApp conversations

The response is of type object.