---
title: "List Whatsapp Conversations"
method: POST
path: "/inbox/whatsapp/conversations"
tags: ["AI Inbox"]
---

# List Whatsapp Conversations

`POST /inbox/whatsapp/conversations`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/inbox/whatsapp/conversations`
- Auth: HTTP bearer

WhatsApp conversations across the organisation's WhatsApp numbers, newest activity first. A read (POST for the filters).

Each row names the CRM contact it is linked to. The contact's id, name and email appear only for contacts the key may
see; for any other the chat row is kept with those fields null (or, when `search` is used, which also matches them, the
row is left out). `configured: false` means the organisation has no WhatsApp numbers.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- WhatsAppConversationsRequest: List filters. Newest activity first; `offset`/`limit` window the list.
  - `offset` integer
  - `limit` integer
  - `search` string, nullable: Name, phone or last-message text.
  - `unread_only` boolean
  - `account_ids` string[], nullable: Restrict to these WhatsApp account ids (`wa_...`).

## Response `200`

Successful Response

- ApiResponseInboxPayload
  - `data` InboxPayload, required: An open envelope for a comment, an assignment or a workspace. Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)