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

# Get phone number details

> Retrieve detailed information about a specific phone number.

By default returns basic information. Use `fields` parameter to request additional data like throughput limits, account mode, certificate status, etc.

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




## OpenAPI

````yaml /api/meta/whatsapp/openapi-whatsapp.yaml get /{phone_number_id}
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:
  /{phone_number_id}:
    parameters:
      - name: phone_number_id
        in: path
        required: true
        description: WhatsApp Business Phone Number ID
        schema:
          type: string
    get:
      tags:
        - Phone Numbers
      summary: Get phone number details
      description: >
        Retrieve detailed information about a specific phone number.


        By default returns basic information. Use `fields` parameter to request
        additional data like throughput limits, account mode, certificate
        status, etc.


        **Proxy endpoint**: Proxies directly to Meta Graph API.
      operationId: getPhoneNumber
      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


            Example:
            `fields=id,verified_name,display_phone_number,quality_rating,throughput,messaging_limit_tier`
          schema:
            type: string
          example: id,verified_name,display_phone_number,quality_rating
      responses:
        '200':
          description: Phone number details retrieved successfully
          content:
            application/json:
              schema:
                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
                    properties:
                      level:
                        type: string
                        description: Current throughput level
                  account_mode:
                    type: string
                    enum:
                      - SANDBOX
                      - LIVE
                    description: Account mode (SANDBOX for testing, LIVE for production)
                  certificate:
                    type: string
                    description: Certificate status
                  messaging_limit_tier:
                    type: string
                    description: >-
                      Current messaging limit tier (TIER_50, TIER_250, TIER_1K,
                      TIER_10K, TIER_100K, TIER_UNLIMITED)
              example:
                id: '1906385232743451'
                verified_name: Jasper's Market
                display_phone_number: +1 631-555-5555
                quality_rating: GREEN
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    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
  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.

````