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

# List broadcast recipients

> Get paginated list of recipients with delivery and response status.




## OpenAPI

````yaml api/legacy/openapi-platform.yaml get /whatsapp_broadcasts/{broadcast_id}/recipients
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}/recipients:
    get:
      tags:
        - WhatsApp Broadcasts
      summary: List broadcast recipients
      description: |
        Get paginated list of recipients with delivery and response status.
      operationId: listBroadcastRecipients
      parameters:
        - name: broadcast_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
      responses:
        '200':
          description: List of recipients
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WhatsappBroadcastRecipient'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '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:
    WhatsappBroadcastRecipient:
      type: object
      description: Individual broadcast recipient with delivery status
      properties:
        id:
          type: string
          format: uuid
          example: 8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f
        phone_number:
          type: string
          example: '14155550123'
          description: Normalized phone number without + prefix
        status:
          type: string
          enum:
            - pending
            - sent
            - failed
          example: sent
        sent_at:
          type: string
          format: date-time
          nullable: true
          example: '2025-07-15T10:05:23Z'
        failed_at:
          type: string
          format: date-time
          nullable: true
        delivered_at:
          type: string
          format: date-time
          nullable: true
          example: '2025-07-15T10:05:30Z'
        read_at:
          type: string
          format: date-time
          nullable: true
          example: '2025-07-15T10:12:45Z'
        responded_at:
          type: string
          format: date-time
          nullable: true
          example: '2025-07-15T10:15:00Z'
        error_message:
          type: string
          nullable: true
          example: Invalid phone number
        error_details:
          type: object
          nullable: true
          additionalProperties: true
          example:
            error_code: '131047'
            error_subcode: '2494055'
        template_parameters:
          oneOf:
            - type: array
              items:
                type: string
              example:
                - Param1
                - Param2
            - type: object
              additionalProperties: true
              example:
                first_name: Alicia
                discount_code: JULY25
                expiry: '2025-07-31'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaginationMeta:
      type: object
      properties:
        page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 20
        total_pages:
          type: integer
          example: 5
        total_count:
          type: integer
          example: 100
    Error:
      type: object
      properties:
        error:
          type: string
          example: Resource not found
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your project API key

````