> ## 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 configs

> Returns a list of WhatsApp configurations available to the project.

Results are scoped to configurations accessible by the API key's project.




## OpenAPI

````yaml api/legacy/openapi-whatsapp.yaml get /whatsapp_configs
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_configs:
    get:
      tags:
        - WhatsApp Configs
      summary: List WhatsApp configs
      description: >
        Returns a list of WhatsApp configurations available to the project.


        Results are scoped to configurations accessible by the API key's
        project.
      operationId: listWhatsappConfigs
      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: business_account_id
          in: query
          description: Filter by WhatsApp Business Account ID
          schema:
            type: string
          example: '123456789012345'
        - name: q[business_account_id_eq]
          in: query
          description: Filter by exact WhatsApp Business Account ID (Ransack syntax)
          schema:
            type: string
          example: '123456789012345'
        - name: q[name_cont]
          in: query
          description: Filter by name containing string
          schema:
            type: string
        - name: q[created_at_gteq]
          in: query
          description: Filter by created date >= (ISO 8601 format)
          schema:
            type: string
            format: date-time
        - name: q[created_at_lteq]
          in: query
          description: Filter by created date <= (ISO 8601 format)
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: List of WhatsApp configurations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WhatsappConfig'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    WhatsappConfig:
      type: object
      description: >
        WhatsApp configuration resource returned by the External API.

        Sensitive write-only fields like `webhook_verify_token`,
        `webhook_destination_url`,

        and `access_token` are intentionally omitted from responses.
      properties:
        id:
          type: string
          example: config-123abc
        name:
          type: string
          example: Client WhatsApp
        display_name:
          type: string
          example: Client WhatsApp (+1234567890)
        phone_number_id:
          type: string
          example: '1234567890'
        business_account_id:
          type: string
          example: '98765432109'
        kind:
          type: string
          enum:
            - production
            - sandbox
          example: production
          description: Configuration environment type
        display_phone_number:
          type: string
          example: +56 9 61461262
          description: Formatted phone number for display purposes
        display_phone_number_normalized:
          type: string
          example: '56961461262'
          description: Normalized phone number without + prefix
        is_coexistence:
          type: boolean
          description: Indicates whether coexistence mode is enabled for this phone number
        webhook_verified_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp of the last successful webhook verification
        customer_id:
          type: string
          format: uuid
          example: customer-456def
        inbound_processing_enabled:
          type: boolean
          example: true
          description: Whether inbound message processing is enabled for this configuration
        calls_enabled:
          type: boolean
          example: false
          description: Whether voice calling is enabled for this configuration
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaginationMeta:
      type: object
      properties:
        page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 20
        total_pages:
          type: integer
          example: 5
        total_count:
          type: integer
          example: 100
    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

````