> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryhealvi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the list of recipients for a campaign by ID.




## OpenAPI

````yaml /openapi/chat-client.yaml get /whatsapp/campaigns/{id}/recipients
openapi: 3.0.3
info:
  version: 1.0.0
  title: HealviChat Client API
servers:
  - url: https://{tenant_domain}/third-party/v1
    variables:
      tenant_domain:
        default: your-tenant.onhealvi.com
        description: Your tenant domain
security:
  - bearerAuth: []
paths:
  /whatsapp/campaigns/{id}/recipients:
    get:
      tags:
        - whatsapp
      summary: |
        Get the list of recipients for a campaign by ID.
      parameters:
        - in: path
          name: id
          schema:
            type: integer
          required: true
        - in: query
          name: per_page
          description: >-
            Optional number of recipients per page. Returns full list when
            omitted.
          schema:
            type: integer
          required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WhatsappCampaignRecipient'
components:
  schemas:
    WhatsappCampaignRecipient:
      type: object
      properties:
        id:
          type: integer
        campaign_id:
          type: integer
        profile_id:
          type: integer
          nullable: true
        conversation_id:
          type: integer
          nullable: true
        message_id:
          type: integer
          nullable: true
        name:
          type: string
          nullable: true
        phone_number:
          type: string
        placeholders:
          type: object
          description: >
            Key-value object with the values for placeholders when used to fill
            variables.

            Used as is, no delimiters are added.
        sent_at:
          type: string
          format: date-time
          nullable: true
          example: '2023-01-01T12:00:00Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````