> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chatflows.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Conversations

> Returns a list of your WhatsApp and Messenger conversations. The most recent conversation is first.

You can filter the list by customer, WhatsApp number or status.


## OpenAPI

````yaml /api-collection/chatflows-api-v1.json get /api/v1/conversations
openapi: 3.1.0
info:
  title: ChatFlows REST API
  version: 1.0.0
  description: >-
    ChatFlows REST API (v1).


    **Base URL:** `https://app.chatflows.io/api/v1` — also shown, with a copy
    button, on your **Developer API Keys** page.


    **Auth:** every authenticated request sends `Authorization: Bearer <token>`,
    where the token is created under **Setup → Developer API Keys** in your
    dashboard.


    **What a token can see:** a token belongs to ONE workspace — your store's.
    Every endpoint returns only that workspace's data, and `/api/v1/account`
    describes your own workspace. A token created before tokens were tied to a
    workspace is refused with `401 token_not_scoped`; create a new one to
    replace it.


    **Scopes:** each endpoint's description lists the token ability it requires.
    Create your token with the matching scopes.


    **Pagination:** list endpoints return `{ data, links: { next, prev }, meta
    }`. Large/append-only collections (contacts, group members, webhooks) use
    opaque cursor pagination — follow `links.next` until it is `null`.
    `per_page` is clamped to 5–100.


    **Async sends:** message and OTP sends return `202` and are processed on the
    queue.


    **Error envelope:**

    ```json

    { "message": "...", "error_code": "...", "status": 4xx }

    ```


    **Modules:** Auth/Account · Channels · Contacts · Statuses · Sources ·
    Groups · Labels · Templates · Messages · Conversations · OTP.
servers:
  - url: https://app.chatflows.io
    description: ChatFlows
security:
  - bearerAuth: []
tags:
  - name: Root
    description: Unauthenticated service metadata.
  - name: Auth & Account
    description: Verify your token, and read workspace identity, plan and usage.
  - name: Channels
    description: Connected WhatsApp accounts and their phone numbers.
  - name: Customers
    description: Create, read, update, merge and bulk-manage customers.
  - name: Customer Statuses
    description: The pipeline statuses a contact can be assigned.
  - name: Customer Sources
    description: Where a contact originated (e.g. website, referral).
  - name: Customer Groups
    description: Named groups used to segment contacts and target campaigns.
  - name: Customer Labels
    description: Free-form labels for tagging contacts.
  - name: Templates
    description: WhatsApp message templates and their Meta approval status.
  - name: Messages
    description: Send template and free-form messages, and read delivery status.
  - name: Conversations
    description: Customer conversation threads and their message history.
  - name: OTP
    description: Send, verify and resend one-time passcodes over WhatsApp.
  - name: Error Examples
    description: Reference shapes for the errors any endpoint may return.
paths:
  /api/v1/conversations:
    get:
      tags:
        - Conversations
      summary: List Conversations
      operationId: conversationsListConversations
      parameters:
        - name: contact_id
          in: query
          schema:
            type: integer
          description: Only chats with this customer.
        - name: channel_id
          in: query
          schema:
            type: integer
          description: Only chats on this WhatsApp number.
        - name: status
          in: query
          schema:
            type: string
            enum:
              - open
              - pending
              - assigned
              - resolved
              - closed
          description: Only chats with this status.
        - name: per_page
          in: query
          schema:
            type: integer
            default: 25
            minimum: 5
            maximum: 100
          description: Chats per page, from 5 to 100.
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: The chat ID.
                        contact_id:
                          type: integer
                          description: The customer's ID.
                        contact:
                          type: object
                          properties:
                            id:
                              type: integer
                            display_name:
                              type: string
                            phone:
                              type: string
                            email:
                              type: string
                            is_active:
                              type: boolean
                            created_at:
                              type: string
                          description: Short details of the customer.
                        channel_id:
                          type: integer
                          description: The WhatsApp number the chat is on.
                        platform:
                          type: string
                          description: '`whatsapp` or `messenger`.'
                        status:
                          type: string
                          description: >-
                            `open`, `pending`, `assigned`, `resolved` or
                            `closed`.
                        priority:
                          type: string
                          description: The chat's priority.
                        unread_count:
                          type: integer
                          description: Messages your team hasn't read yet.
                        last_message_at:
                          type: string
                          description: When the last message was sent or received.
                        last_message_preview:
                          type: string
                          description: The start of the last message.
                        last_message_direction:
                          type: string
                          description: >-
                            `inbound` if the customer sent it, `outbound` if you
                            did.
                        window_expires_at:
                          type: string
                          description: When the 24-hour reply window ends.
                        free_entry_point_expires_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: >-
                            If the chat started from a Facebook ad or page post,
                            when its free 72-hour messaging period ends.
                        free_entry_point_source:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Where that free period came from: `ad` or
                            `page_cta`.
                        is_window_open:
                          type: boolean
                          description: '`true` if you can still send a text reply.'
                        first_message_at:
                          type: string
                          description: When the chat started.
                        last_inbound_at:
                          type: string
                          description: When the customer last wrote.
                        last_outbound_at:
                          type: string
                          description: When you last wrote.
                        resolved_at:
                          description: When the chat was resolved.
                        closed_at:
                          description: When the chat was closed.
                        created_at:
                          type: string
                          description: When the chat was created.
                        updated_at:
                          type: string
                          description: When the chat last changed.
                  links:
                    type: object
                    properties:
                      next: {}
                      prev: {}
                  meta:
                    type: object
                    properties:
                      per_page:
                        type: integer
                      next_cursor: {}
                      prev_cursor: {}
              examples:
                200 OK:
                  summary: 200 OK
                  value:
                    data:
                      - id: 12
                        contact_id: 1
                        contact:
                          id: 1
                          display_name: Jane Doe
                          phone: '+919876543210'
                          email: jane@example.com
                          is_active: true
                          created_at: '2026-06-26T10:00:00+00:00'
                        channel_id: 2
                        platform: whatsapp
                        status: open
                        priority: normal
                        unread_count: 1
                        last_message_at: '2026-06-26T10:05:00+00:00'
                        last_message_preview: Thanks for reaching out!
                        last_message_direction: inbound
                        window_expires_at: '2026-06-27T10:05:00+00:00'
                        free_entry_point_expires_at: null
                        free_entry_point_source: null
                        is_window_open: true
                        first_message_at: '2026-06-26T09:00:00+00:00'
                        last_inbound_at: '2026-06-26T10:05:00+00:00'
                        last_outbound_at: '2026-06-26T10:01:00+00:00'
                        resolved_at: null
                        closed_at: null
                        created_at: '2026-06-26T09:00:00+00:00'
                        updated_at: '2026-06-26T10:05:00+00:00'
                    links:
                      next: null
                      prev: null
                    meta:
                      per_page: 25
                      next_cursor: null
                      prev_cursor: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/QuotaExhausted'
      security:
        - bearerAuth:
            - conversations:read
components:
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or expired API token — or an older token that is not
        tied to a workspace (`token_not_scoped`), in which case create a new one
        on the Developer API Keys page.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Missing API token.
            error_code: unauthenticated
            status: 401
    PaymentRequired:
      description: >-
        Your workspace has no active subscription, or its first payment is still
        pending.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Subscription required or expired.
            error_code: subscription_required
            status: 402
    Forbidden:
      description: >-
        The token lacks the required scope, or the account is suspended or on
        hold.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: 'This token is missing the required scope: contacts:write.'
            error_code: insufficient_scope
            status: 403
    QuotaExhausted:
      description: The monthly API request quota for the workspace is exhausted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: API request quota exhausted for this billing period.
            error_code: quota_exhausted
            status: 429
      headers:
        RateLimit-Limit:
          schema:
            type: integer
          description: Your API request quota for the current billing period.
        RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining in the current billing period.
        RateLimit-Reset:
          schema:
            type: integer
          description: Seconds until the quota resets.
  schemas:
    Error:
      type: object
      description: Standard error envelope returned by every endpoint.
      properties:
        message:
          type: string
          description: Human-readable explanation.
        error_code:
          type: string
          description: Stable machine-readable code — branch on this, not the message.
        status:
          type: integer
          description: HTTP status code.
      required:
        - message
        - error_code
        - status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API key. Create one under **Setup → Developer API Keys** and select
        the permissions this endpoint needs.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.