List conversations

List conversations. GET /api/ext/v3/conversations. Returns conversations, newest first. Filter by channel_type and/or channel_id. Results can be limited by the active channel scope; do not assume all connected channels are included. The returned id can be used as the target of other conversation APIs. The whatsapp filter excludes WhatsApp group conversations; use whatsapp_group to filter those conversation records.

Permissions

For API access tokens and OIDC tokens, satisfy at least one of: api, conversationsv3:read. API access tokens may satisfy a listed scope through the configured scope hierarchy; OIDC tokens are checked against their scope claims. Legacy JWT authentication does not use this scope check. Authentication, role, tenant, and applicable feature or plan checks still apply. For HTTP 403, check the credential type, applicable scopes, roles, and workspace access; 403 does not always mean a missing scope. Authentication/authorization failures do not guarantee a JSON response body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
required
≥ 1

Page number (1-based); must be at least 1.

int32
required
1 to 100

Number of items per page, from 1 to 100.

string

Filter by channel type (case-insensitive): whatsapp, whatsapp_group, instagram, messenger, tiktok, webchat, or rcs. whatsapp excludes WhatsApp groups; whatsapp_group selects them. Omit for all types.

string

Filter by connected channel ID; can be combined with channel_type. Omit for all channels.

Responses

401

The request is unauthorized.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json