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

# List phone numbers

> Get WhatsApp numbers in your project, most recent first.



## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml get /whatsapp/phone_numbers
openapi: 3.1.0
info:
  title: Kapso Platform API
  version: 0.2.0
  description: >
    Build WhatsApp messaging into your product. Manage customers, connect phone
    numbers, send broadcasts, and handle conversations.
servers:
  - url: https://api.kapso.ai/platform/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Customers
    description: Manage customer accounts
  - name: Setup Links
    description: WhatsApp onboarding via embedded signup
  - name: Phone Numbers
    description: Connect and manage WhatsApp numbers
  - name: Webhooks
    description: Subscribe to WhatsApp events
  - name: Display Names
    description: Update WhatsApp business display names
  - name: Broadcasts
    description: |
      Send template messages at scale

      **Alpha**: This API is in alpha and subject to change
  - name: Conversations
    description: Manage conversation state
  - name: Media
    description: Upload media files for WhatsApp messaging
  - name: Users
    description: Manage project team members
  - name: Inbox Embeds
    description: Create and manage embeddable inbox access links
  - name: Webhook Deliveries
    description: View webhook delivery attempts and their status
  - name: External API Logs
    description: View logs of external API calls made by the project
  - name: Log Search
    description: Search Logs V2 events across API, Meta, workflow, and webhook sources
  - name: Provider Models
    description: List available AI provider models
  - name: WhatsApp Flows
    description: Build interactive WhatsApp Flows for surveys and forms
  - name: Contacts
    description: Manage WhatsApp contacts
paths:
  /whatsapp/phone_numbers:
    get:
      tags:
        - Phone Numbers
      summary: List phone numbers
      description: Get WhatsApp numbers in your project, most recent first.
      operationId: listWhatsappPhoneNumbers
      parameters:
        - name: phone_number_id
          in: query
          description: Filter by Meta phone number ID
          schema:
            type: string
        - name: business_account_id
          in: query
          description: Filter by WABA ID
          schema:
            type: string
        - name: customer_id
          in: query
          schema:
            type: string
            format: uuid
        - name: messaging_enabled
          in: query
          schema:
            type: boolean
        - name: name_contains
          in: query
          schema:
            type: string
        - name: created_after
          in: query
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          schema:
            type: string
            format: date-time
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 20
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: Success
          headers:
            X-Total:
              schema:
                type: integer
            X-Total-Pages:
              schema:
                type: integer
            X-Per-Page:
              schema:
                type: integer
            X-Page:
              schema:
                type: integer
            Link:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhatsappPhoneNumberListResponse'
              examples:
                multiple:
                  value:
                    data:
                      - id: '1234567890'
                        internal_id: 4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d
                        phone_number_id: '1234567890'
                        name: Support Line
                        business_account_id: '98765432109'
                        is_coexistence: false
                        inbound_processing_enabled: true
                        calls_enabled: false
                        webhook_verified_at: '2025-01-14T15:10:00Z'
                        created_at: '2025-01-14T15:00:00Z'
                        updated_at: '2025-01-14T15:10:00Z'
                        display_name: Support Line
                        display_phone_number: +1 555-123-4567
                        display_phone_number_normalized: '15551234567'
                        verified_name: Acme Corp
                        quality_rating: GREEN
                        throughput_tier: TIER_10K
                        whatsapp_business_manager_messaging_limit: '10000'
                        customer_id: 3f2e1d0c-9b8a-7f6e-5d4c-3b2a1f0e9d8c
                        code_verification_status: COMPLETED
                        name_status: APPROVED
                        status: CONNECTED
                        is_official_business_account: false
                        is_pin_enabled: true
                    meta:
                      page: 1
                      per_page: 20
                      total_pages: 1
                      total_count: 1
        '401':
          $ref: '#/components/responses/UnauthorizedError'
components:
  schemas:
    WhatsappPhoneNumberListResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WhatsappPhoneNumber'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    WhatsappPhoneNumber:
      type: object
      required:
        - id
        - internal_id
        - phone_number_id
        - name
        - created_at
        - updated_at
      properties:
        id:
          type: string
          description: Meta phone number ID
        internal_id:
          type: string
          format: uuid
          description: Kapso configuration ID
        phone_number_id:
          type: string
          description: Meta phone number ID
        name:
          type: string
          description: Label for this number
        business_account_id:
          type:
            - string
            - 'null'
          description: WhatsApp Business Account ID
        is_coexistence:
          type:
            - boolean
            - 'null'
          description: Using with WhatsApp Business App
        inbound_processing_enabled:
          type: boolean
          description: Process incoming messages
        calls_enabled:
          type: boolean
          description: Handle voice calls
        webhook_verified_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When Meta confirmed webhook
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        customer_id:
          type:
            - string
            - 'null'
          format: uuid
        display_name:
          type:
            - string
            - 'null'
          description: Customer-facing display name
        display_phone_number:
          type:
            - string
            - 'null'
          description: Formatted number from Meta
        display_phone_number_normalized:
          type:
            - string
            - 'null'
          description: Digits only
        verified_name:
          type:
            - string
            - 'null'
          description: Meta-verified business name
        quality_rating:
          type:
            - string
            - 'null'
          description: GREEN, YELLOW, or RED
        code_verification_status:
          type:
            - string
            - 'null'
        name_status:
          type:
            - string
            - 'null'
          description: Display name review status
        status:
          type:
            - string
            - 'null'
          description: Connection status (e.g., CONNECTED)
        throughput_tier:
          type:
            - string
            - 'null'
          description: Message rate limit tier
        whatsapp_business_manager_messaging_limit:
          anyOf:
            - type: integer
            - type: string
            - type: 'null'
        is_official_business_account:
          type:
            - boolean
            - 'null'
          description: Green checkmark verified
        is_pin_enabled:
          type:
            - boolean
            - 'null'
          description: Two-factor PIN enabled
    PaginationMeta:
      type: object
      required:
        - page
        - per_page
        - total_pages
        - total_count
      properties:
        page:
          type: integer
          minimum: 1
        per_page:
          type: integer
          minimum: 1
        total_pages:
          type: integer
          minimum: 0
        total_count:
          type: integer
          minimum: 0
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
  responses:
    UnauthorizedError:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````