> ## 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 recipients > Get recipients for this broadcast with delivery status. ## OpenAPI ````yaml /api/platform/v1/openapi-platform.yaml get /whatsapp/broadcasts/{broadcast_id}/recipients 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/broadcasts/{broadcast_id}/recipients: parameters: - name: broadcast_id in: path required: true schema: type: string format: uuid get: tags: - Broadcasts summary: List recipients description: Get recipients for this broadcast with delivery status. operationId: listWhatsappBroadcastRecipients parameters: - name: per_page in: query schema: type: integer minimum: 1 - name: page in: query schema: type: integer minimum: 1 responses: '200': description: OK 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/WhatsappBroadcastRecipientListResponse' examples: recipients: value: data: - id: 8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f phone_number: '14155550123' status: sent sent_at: '2025-07-15T10:05:23Z' delivered_at: '2025-07-15T10:05:30Z' read_at: '2025-07-15T10:12:45Z' responded_at: '2025-07-15T10:15:00Z' created_at: '2025-07-15T10:00:00Z' updated_at: '2025-07-15T10:15:00Z' template_components: - type: body parameters: - type: text parameter_name: first_name text: Alicia - type: text parameter_name: discount_code text: SAVE25 - id: 7b8c9d0e-1f2a-3b4c-5d6e-7f8a9b0c1d2e phone_number: '14155550124' status: failed sent_at: '2025-07-15T10:05:30Z' failed_at: '2025-07-15T10:05:32Z' error_message: Invalid phone number error_details: error_code: '131047' error_subcode: '2494055' created_at: '2025-07-15T10:00:10Z' updated_at: '2025-07-15T10:05:32Z' template_components: - type: body parameters: - type: text parameter_name: first_name text: Jane - type: text parameter_name: discount text: SAVE40 meta: page: 1 per_page: 20 total_pages: 1 total_count: 2 '401': $ref: '#/components/responses/UnauthorizedError' '404': $ref: '#/components/responses/NotFoundError' components: schemas: WhatsappBroadcastRecipientListResponse: type: object required: - data - meta properties: data: type: array items: $ref: '#/components/schemas/WhatsappBroadcastRecipient' meta: $ref: '#/components/schemas/PaginationMeta' WhatsappBroadcastRecipient: type: object required: - id - phone_number - status - created_at - updated_at properties: id: type: string format: uuid phone_number: type: string description: E.164 format, no plus status: type: string description: Delivery status sent_at: type: - string - 'null' format: date-time failed_at: type: - string - 'null' format: date-time error_message: type: - string - 'null' delivered_at: type: - string - 'null' format: date-time read_at: type: - string - 'null' format: date-time responded_at: type: - string - 'null' format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time template_components: type: array description: Meta-style template components items: type: object additionalProperties: true error_details: type: - object - 'null' additionalProperties: true description: Meta error payload 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 ````