Skip to main content
GET
List conversations

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

status
enum<string>

Filter by conversation status

Available options:
active,
ended
assigned_user_id
string<uuid>

Filter by active assignee user ID (must be a project member)

unassigned
boolean

Filter conversations with no active assignment. Cannot be combined with assigned_user_id.

last_active_since
string<date-time>

Filter conversations active on or after this time (ISO 8601)

last_active_until
string<date-time>

Filter conversations active on or before this time (ISO 8601)

phone_number
string

Filter by contact phone number

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 conversations

data
object[]
required
paging
object