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

> List all phone numbers associated with a business account.

Returns basic phone number information including verification status and quality rating.

**Proxy endpoint**: Proxies directly to Meta Graph API.




## OpenAPI

````yaml /api/meta/whatsapp/openapi-whatsapp.yaml get /{business_account_id}/phone_numbers
openapi: 3.1.0
info:
  title: Kapso Meta Proxy API
  version: 1.0.0
  description: >
    Kapso's Meta Proxy API provides a unified interface to WhatsApp Business
    Platform with enhanced features and Kapso-specific extensions.


    This API acts as a proxy layer between your application and WhatsApp,
    adding:

    - Simplified authentication with project-level API keys

    - Enhanced message metadata and tracking

    - Conversation management capabilities

    - Voice call integration

    - Extended contact and template management


    ## Base URL


    All API requests are made to: `https://api.kapso.ai/meta/whatsapp/v24.0`


    ## Authentication


    The API supports authentication via **X-API-Key header** (recommended):


    ```

    X-API-Key: your_project_api_key

    ```


    Alternative: Bearer token authentication is also supported for backward
    compatibility:


    ```

    Authorization: Bearer your_access_token

    ```


    Note: X-API-Key is the recommended authentication method for the Meta Proxy
    API.
  contact:
    name: Kapso Support
    url: https://kapso.ai
    email: dev@kap.so
servers:
  - url: https://api.kapso.ai/meta/whatsapp/v24.0
    description: Production server
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Messages
    description: Send and retrieve WhatsApp messages
  - name: Conversations
    description: Manage WhatsApp conversations
  - name: Contacts
    description: Manage WhatsApp contacts
  - name: Templates
    description: Manage message templates
  - name: Media
    description: Upload and retrieve media files
  - name: Calls
    description: Manage voice calls
  - name: Settings
    description: Account settings and configuration
  - name: Business Profile
    description: Business profile management
  - name: Phone Numbers
    description: Phone number management
  - name: Flows
    description: WhatsApp Flow management (Beta)
  - name: Block Users
    description: Block and unblock WhatsApp users
  - name: Usernames
    description: Reserve and manage WhatsApp business usernames
paths:
  /{business_account_id}/phone_numbers:
    parameters:
      - name: business_account_id
        in: path
        required: true
        description: WhatsApp Business Account ID
        schema:
          type: string
    get:
      tags:
        - Phone Numbers
      summary: List phone numbers
      description: >
        List all phone numbers associated with a business account.


        Returns basic phone number information including verification status and
        quality rating.


        **Proxy endpoint**: Proxies directly to Meta Graph API.
      operationId: listPhoneNumbers
      parameters:
        - name: fields
          in: query
          required: false
          description: >
            Comma-separated list of fields to retrieve.


            Available fields: id, verified_name, display_phone_number,
            quality_rating, code_verification_status,
            is_official_business_account, name_status, new_name_status,
            platform_type, throughput, account_mode, certificate,
            messaging_limit_tier
          schema:
            type: string
          example: id,verified_name,display_phone_number,quality_rating
      responses:
        '200':
          description: Phone numbers retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Phone number ID
                        verified_name:
                          type: string
                          description: >-
                            Verified business name associated with the phone
                            number
                        display_phone_number:
                          type: string
                          description: Phone number in international format
                        quality_rating:
                          type: string
                          enum:
                            - GREEN
                            - YELLOW
                            - RED
                            - NA
                            - UNKNOWN
                          description: |
                            Quality rating based on message delivery.
                            - GREEN: High quality
                            - YELLOW: Medium quality
                            - RED: Low quality
                            - NA: Not yet determined
                            - UNKNOWN: Status unknown
                        code_verification_status:
                          type: string
                          description: Verification status of the phone number
                        is_official_business_account:
                          type: boolean
                          description: Whether this is an official business account
                        name_status:
                          type: string
                          description: Status of the business name
                        new_name_status:
                          type: string
                          description: Status of pending name change
                        platform_type:
                          type: string
                          description: Platform type (CLOUD_API, etc.)
                        throughput:
                          type: object
                          description: Messaging throughput limits
                        account_mode:
                          type: string
                          enum:
                            - SANDBOX
                            - LIVE
                          description: Account mode
                        certificate:
                          type: string
                          description: Certificate status
                        messaging_limit_tier:
                          type: string
                          description: Current messaging limit tier
                  paging:
                    $ref: '#/components/schemas/Paging'
              example:
                data:
                  - id: '1906385232743451'
                    verified_name: Jasper's Market
                    display_phone_number: +1 631-555-5555
                    quality_rating: GREEN
                  - id: '1913623884432103'
                    verified_name: Jasper's Ice Cream
                    display_phone_number: +1 631-555-5556
                    quality_rating: NA
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Paging:
      type: object
      properties:
        cursors:
          $ref: '#/components/schemas/PaginationCursor'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - code
          properties:
            message:
              type: string
              description: Human-readable error message
              example: Invalid phone number format
            type:
              type: string
              description: Error category
              example: OAuthException
            code:
              type: integer
              description: Error code
              example: 400
            error_subcode:
              type: integer
              description: More specific error code
              example: 1001
            fbtrace_id:
              type: string
              description: Facebook trace ID for debugging
              example: AXk7s_8dR4eVHp9Kq2MmNlO
    PaginationCursor:
      type: object
      properties:
        before:
          type: string
          description: Cursor for previous page (Base64 encoded)
          example: >-
            eyJ2YWx1ZXMiOlsiMjAyNC0wMS0xNVQxMjozNDo1Ni4xMjM0NTZaIiwiMTIzNDUiXSwiY29sdW1ucyI6WyJjcmVhdGVkX2F0IiwiaWQiXX0=
        after:
          type: string
          description: Cursor for next page (Base64 encoded)
          example: >-
            eyJ2YWx1ZXMiOlsiMjAyNC0wMS0xNFQwOToyMTozMi43ODkwMTJaIiwiMTIzMjAiXSwiY29sdW1ucyI6WyJjcmVhdGVkX2F0IiwiaWQiXX0=
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >
        Project API key for authentication. This is the recommended
        authentication method.


        Get your API key from the Kapso dashboard under Integrations > API keys.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        Bearer token authentication (alternative method).

        Note: X-API-Key authentication is recommended for the Meta Proxy API.

````