---
title: "List Conversations"
method: GET
path: "/conversations/all"
tags: ["Conversations"]
---

# List Conversations

`GET /conversations/all`

## Request

- Base URL: `https://developers.chatway.app/api/v1`
- URL: `https://developers.chatway.app/api/v1/conversations/all`
- Auth: API key in header `X-API-KEY`

Retrieve one page of conversations. Use each conversation's data[].id to read its messages, send a reply or change its status. Open conversations appear first, followed by ordering based on the latest message activity, newest first.

## Query parameters

- `limit` integer, nullable
- `page` integer, nullable
- `include_fields` string, nullable
- `exclude_fields` string, nullable

## Response `200`

Paginated list responses include `data`, `meta.pagination`, and `links`. Use the `page` and `limit` query parameters to walk results. Follow `links.next` until it is `null`, or increment `page` until `current_page >= total_pages`.

| Field | Description |
|---|---|
| `meta.pagination.total` | Total records across all pages |
| `meta.pagination.count` | Records returned on this page |
| `meta.pagination.per_page` | Page size used for this response (matches `limit`) |
| `meta.pagination.current_page` | Current page number (1-based) |
| `meta.pagination.total_pages` | Total number of pages |
| `links.next` | URL for the next page, or `null` on the last page |
| `links.first` / `links.last` | First and last page URLs |

New messages can change the conversation order while you read successive pages. Keep track of conversation IDs when importing results. For ongoing message updates, use webhooks rather than repeatedly scanning the conversation list.

- object
  - `data` object[], required
    - `type` string, required
    - `id` string, required
    - `attributes` object, required: Returned attributes depend on include_fields and exclude_fields. Filtered-out attributes are omitted. The field types below apply when an attribute is present. If both filters are supplied, only include_fields is applied.
      - `is_resolved` boolean
      - `contact_id` string
      - `agents` object: Agents added to the conversation, as an object that maps each agent ID to that agent's name. It is an empty array (`[]`) when the conversation has no agents.
      - `contact_name` string, nullable
      - `unread_messages` integer
      - `created_at` string, nullable
      - `latest_message` object, nullable: The conversation's most recent message that is not a system message (it can be an internal note), or null when there is none. `url` holds the attachment data stored with that message, or null.
        - `content` string, nullable, required
        - `url` unknown[], nullable, required
          - unknown
  - `meta` object, required
    - `pagination` object, required
      - `total` integer, required
      - `count` integer, required
      - `per_page` integer, required
      - `current_page` integer, required
      - `total_pages` integer, required
  - `links` object, required
    - `self` string, required
    - `first` string, required
    - `next` string, nullable, required
    - `last` string, required

## Other responses

- `403`: Authorization error
- `422`: Validation error

---

[API](https://skmtc.dev/chatway/apis/chatway-developer-docs.md) · [All operations](https://skmtc.dev/chatway/apis/chatway-developer-docs/llms.txt) · [OpenAPI document](https://skmtc.dev/chatway/apis/chatway-developer-docs/revisions/ca1a1da291cc?raw)