> ## 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 display name requests

> View all display name change requests for this number, most recent first.



## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml get /whatsapp/phone_numbers/{phone_number_id}/display_name_requests
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/{phone_number_id}/display_name_requests:
    parameters:
      - name: phone_number_id
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Display Names
      summary: List display name requests
      description: >-
        View all display name change requests for this number, most recent
        first.
      operationId: listWhatsappDisplayNameRequests
      parameters:
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: Display name requests retrieved
          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/WhatsappDisplayNameRequestListResponse'
              examples:
                multiple_requests:
                  summary: Recent requests with different statuses
                  value:
                    data:
                      - id: 2b0f4a1e-7a58-4a15-b0c9-0d7f1a2b3c4d
                        phone_number_id: '1234567890'
                        requested_display_name: Acme Support
                        previous_display_name: +1 555-123-4567
                        status: applied
                        submitted_at: '2025-07-14T15:00:00Z'
                        reviewed_at: '2025-07-15T12:34:00Z'
                        applied_at: '2025-07-16T09:00:00Z'
                        meta_error_code: null
                        meta_error_subcode: null
                        meta_error_type: null
                        meta_error_message: null
                      - id: 8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f
                        phone_number_id: '1234567890'
                        requested_display_name: TechCorp Customer Service
                        previous_display_name: Acme Support
                        status: pending_review
                        submitted_at: '2025-07-20T10:30:00Z'
                        reviewed_at: null
                        applied_at: null
                        meta_error_code: null
                        meta_error_subcode: null
                        meta_error_type: null
                        meta_error_message: null
                      - id: 3f4a5b6c-7d8e-9f0a-1b2c-3d4e5f6a7b8c
                        phone_number_id: '1234567890'
                        requested_display_name: ACME Inc
                        previous_display_name: +1 555-123-4567
                        status: declined
                        submitted_at: '2025-06-15T08:00:00Z'
                        reviewed_at: '2025-06-16T14:22:00Z'
                        applied_at: null
                        meta_error_code: 100
                        meta_error_subcode: 2388135
                        meta_error_type: OAuthException
                        meta_error_message: >-
                          Display name does not match business verification
                          details
                    meta:
                      current_page: 1
                      total_pages: 1
                      total_count: 3
                      per_page: 20
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  schemas:
    WhatsappDisplayNameRequestListResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WhatsappDisplayNameRequest'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    WhatsappDisplayNameRequest:
      type: object
      required:
        - id
        - requested_display_name
        - status
        - submitted_at
      properties:
        id:
          type: string
          format: uuid
        phone_number_id:
          type:
            - string
            - 'null'
          description: Meta phone number ID
        requested_display_name:
          type: string
        previous_display_name:
          type:
            - string
            - 'null'
          description: Previous display name
        status:
          type: string
          enum:
            - submitted
            - pending_review
            - approved
            - available_without_review
            - deferred
            - declined
            - expired
            - no_review
            - failed
            - applied
            - cancelled
        submitted_at:
          type: string
          format: date-time
        reviewed_at:
          type:
            - string
            - 'null'
          format: date-time
        applied_at:
          type:
            - string
            - 'null'
          format: date-time
        meta_error_code:
          type:
            - integer
            - 'null'
        meta_error_subcode:
          type:
            - integer
            - 'null'
        meta_error_type:
          type:
            - string
            - 'null'
        meta_error_message:
          type:
            - string
            - 'null'
    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'
    NotFoundError:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````