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

# Get broadcast details

> Poll overall progress and metrics for a broadcast.

Use this endpoint to monitor broadcast progress and get delivery statistics.




## OpenAPI

````yaml api/legacy/openapi-platform.yaml get /whatsapp_broadcasts/{broadcast_id}
openapi: 3.0.3
info:
  title: Kapso Platform API
  description: >-
    Build WhatsApp automation into your SaaS. Let your customers connect their
    own WhatsApp Business accounts.
  version: 1.0.0
  contact:
    name: Kapso Support
servers:
  - url: https://app.kapso.ai/api/v1
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /whatsapp_broadcasts/{broadcast_id}:
    get:
      tags:
        - WhatsApp Broadcasts
      summary: Get broadcast details
      description: >
        Poll overall progress and metrics for a broadcast.


        Use this endpoint to monitor broadcast progress and get delivery
        statistics.
      operationId: getWhatsappBroadcast
      parameters:
        - name: broadcast_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Broadcast ID
      responses:
        '200':
          description: Broadcast details
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WhatsappBroadcast'
              examples:
                draft_broadcast:
                  summary: Draft broadcast
                  value:
                    data:
                      id: 5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c
                      name: July Promo
                      status: draft
                      started_at: null
                      completed_at: null
                      created_at: '2025-07-14T15:00:00Z'
                      updated_at: '2025-07-14T15:00:00Z'
                      whatsapp_config_id: 4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d
                      whatsapp_template:
                        id: 7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d
                        name: july_promo_template
                        language_code: en_US
                        category: MARKETING
                        status: approved
                      total_recipients: 0
                      sent_count: 0
                      failed_count: 0
                      delivered_count: 0
                      read_count: 0
                      responded_count: 0
                      pending_count: 0
                      response_rate: 0
                      stats:
                        total: 0
                        sent: 0
                        failed: 0
                        delivered: 0
                        read: 0
                        responded: 0
                        pending: 0
                sending_broadcast:
                  summary: Broadcast in progress
                  value:
                    data:
                      id: 5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c
                      name: July Promo
                      status: sending
                      started_at: '2025-07-15T10:00:00Z'
                      completed_at: null
                      created_at: '2025-07-14T15:00:00Z'
                      updated_at: '2025-07-15T10:30:00Z'
                      whatsapp_config_id: 4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d
                      whatsapp_template:
                        id: 7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d
                        name: july_promo_template
                        language_code: en_US
                        category: MARKETING
                        status: approved
                      total_recipients: 1000
                      sent_count: 650
                      failed_count: 50
                      delivered_count: 600
                      read_count: 320
                      responded_count: 45
                      pending_count: 300
                      response_rate: 6.9
                      stats:
                        total: 1000
                        sent: 650
                        failed: 50
                        delivered: 600
                        read: 320
                        responded: 45
                        pending: 300
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Broadcast not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    WhatsappBroadcast:
      type: object
      description: WhatsApp broadcast campaign
      properties:
        id:
          type: string
          format: uuid
          example: 5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c
        name:
          type: string
          example: July Promo
        status:
          type: string
          enum:
            - draft
            - sending
            - completed
            - failed
          example: draft
          description: Current broadcast status
        started_at:
          type: string
          format: date-time
          nullable: true
          example: '2025-07-15T10:00:00Z'
        completed_at:
          type: string
          format: date-time
          nullable: true
          example: '2025-07-15T11:30:00Z'
        created_at:
          type: string
          format: date-time
          example: '2025-07-14T15:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-07-15T11:30:00Z'
        whatsapp_config_id:
          type: string
          format: uuid
          example: 4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d
          description: WhatsApp config ID
        whatsapp_template:
          $ref: '#/components/schemas/BasicWhatsappTemplate'
        total_recipients:
          type: integer
          example: 123
          description: Total number of recipients
        sent_count:
          type: integer
          example: 100
        failed_count:
          type: integer
          example: 23
        delivered_count:
          type: integer
          example: 90
        read_count:
          type: integer
          example: 75
        responded_count:
          type: integer
          example: 12
        pending_count:
          type: integer
          example: 0
        response_rate:
          type: number
          format: float
          example: 12
          description: Percentage of recipients who responded
        stats:
          $ref: '#/components/schemas/WhatsappBroadcastStats'
    Error:
      type: object
      properties:
        error:
          type: string
          example: Resource not found
    BasicWhatsappTemplate:
      type: object
      description: Basic WhatsApp template info (nested in broadcast response)
      properties:
        id:
          type: string
          format: uuid
          example: 7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d
        name:
          type: string
          example: july_promo_template
        language_code:
          type: string
          example: en_US
        category:
          type: string
          enum:
            - MARKETING
            - UTILITY
            - AUTHENTICATION
          example: MARKETING
        status:
          type: string
          enum:
            - approved
            - pending
            - rejected
          example: approved
    WhatsappBroadcastStats:
      type: object
      description: Broadcast delivery statistics
      properties:
        total:
          type: integer
          example: 123
        sent:
          type: integer
          example: 100
        failed:
          type: integer
          example: 23
        delivered:
          type: integer
          example: 90
        read:
          type: integer
          example: 75
        responded:
          type: integer
          example: 12
        pending:
          type: integer
          example: 0
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your project API key

````