> ## Documentation Index
> Fetch the complete documentation index at: https://kapso-1adbad2d.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List WhatsApp conversations

> Returns a list of WhatsApp conversations



## OpenAPI

````yaml api/legacy/openapi-whatsapp.yaml get /whatsapp_conversations
openapi: 3.0.3
info:
  title: Kapso External API - WhatsApp API
  description: >-
    API for programmatically interacting with Kapso agents, executions, and
    WhatsApp conversations. This specification includes only WhatsApp API
    endpoints.
  version: 1.0.0
  contact:
    name: Kapso Support
servers:
  - url: https://app.kapso.ai/api/v1
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /whatsapp_conversations:
    get:
      tags:
        - WhatsApp Conversations
      summary: List WhatsApp conversations
      description: Returns a list of WhatsApp conversations
      operationId: listWhatsappConversations
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: q[status_eq]
          in: query
          description: Filter by exact status match
          schema:
            type: string
            enum:
              - active
              - ended
        - name: q[last_active_at_gteq]
          in: query
          description: Filter by last_active_at greater than or equal to (ISO 8601 format)
          schema:
            type: string
            format: date-time
        - name: q[last_active_at_lteq]
          in: query
          description: Filter by last_active_at less than or equal to (ISO 8601 format)
          schema:
            type: string
            format: date-time
        - name: q[whatsapp_config_id_eq]
          in: query
          description: Filter by exact whatsapp_config_id match
          schema:
            type: string
            format: uuid
        - name: q[whatsapp_config_customer_id_eq]
          in: query
          description: Filter by customer_id through whatsapp_config relationship
          schema:
            type: string
            format: uuid
        - name: q[phone_number_eq]
          in: query
          description: Filter by exact phone number match (automatically normalized)
          schema:
            type: string
          example: '+1234567890'
      responses:
        '200':
          description: A list of WhatsApp conversations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WhatsappConversation'
                  meta:
                    type: object
                    properties:
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    WhatsappConversation:
      type: object
      properties:
        id:
          type: string
          example: conversation-202mno
        phone_number:
          type: string
          example: '+1234567890'
        status:
          type: string
          enum:
            - active
            - ended
          example: active
        last_active_at:
          type: string
          format: date-time
        contact_name:
          type: string
          example: John Doe
        whatsapp_config_id:
          type: string
          format: uuid
          example: config-123abc
          description: ID of the WhatsApp configuration this conversation belongs to
    Error:
      type: object
      properties:
        error:
          type: string
          example: Resource not found
        status:
          type: integer
          example: 404
        message:
          type: string
          example: The requested resource could not be found
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key required for all endpoints

````