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

# Recipients of a campaign

> One row per contact and channel, 50 per page. `filter`: all, read_no_reply, replied, unread or failed.



## OpenAPI

````yaml /api-reference/v2.0/openapi.json get /campaigns/{id}/recipients
openapi: 3.1.0
info:
  title: Shortext API
  description: >-
    **Versioning**: every version is a frozen contract. A released version only
    receives additive changes

    (new endpoints, new optional fields, new response fields); anything breaking
    ships in a new version.

    Responses carry `X-Shortext-Api-Version`. When a version is scheduled for
    removal, responses also carry

    `Deprecation` and `Sunset` headers; after the sunset date the version
    answers HTTP 410.

    The list of versions and their status is available at `GET /api/versions`.


    **Responses**: always HTTP 200. Check `success` and `code` (`1000` =
    success), see `ApiEnvelope`.

    On failure, `trace_id` identifies the request for support.


    **Rate limit**: 300 requests per minute per company, shared by all its keys
    and by every API version.

    Responses carry `X-RateLimit-Limit` and `X-RateLimit-Remaining`; beyond the
    limit the API answers

    HTTP 429 with `Retry-After` (seconds) and the usual envelope. Prefer
    webhooks to polling.
  version: '2.0'
servers:
  - url: https://shortext.ny-corp.io/api/v2.0
security: []
tags:
  - name: Agents
    description: Agents
  - name: Knowledge
    description: Knowledge
  - name: Dynamic links
    description: Dynamic links
  - name: Billing
    description: Billing
  - name: Campaigns
    description: Campaigns
  - name: Channels
    description: Channels
  - name: Conversations
    description: Conversations
  - name: Follow-ups
    description: Follow-ups
  - name: Account
    description: Account
  - name: Tickets
    description: Tickets
  - name: Templates
    description: Templates
  - name: Hosted sessions
    description: Hosted sessions
  - name: Webhooks
    description: Webhooks
paths:
  /campaigns/{id}/recipients:
    get:
      tags:
        - Campaigns
      summary: Recipients of a campaign
      description: >-
        One row per contact and channel, 50 per page. `filter`: all,
        read_no_reply, replied, unread or failed.
      operationId: listCampaignRecipients
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: filter
          in: query
          required: false
          schema:
            type: string
            enum:
              - all
              - read_no_reply
              - replied
              - unread
              - failed
        - name: page
          in: query
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: >-
            Always HTTP 200: the outcome is in `success` and `code` (absolute
            value of the response code).
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiEnvelope'
                  - properties:
                      body:
                        allOf:
                          - $ref: '#/components/schemas/ApiPage'
                          - properties:
                              data:
                                type: array
                                items:
                                  $ref: '#/components/schemas/CampaignRecipient'
                            type: object
                    type: object
      security:
        - bearerAuth: []
components:
  schemas:
    ApiEnvelope:
      properties:
        success:
          type: boolean
          example: true
        code:
          type: integer
          example: 1000
        message:
          type: string
          example: Request success.
        body:
          description: Endpoint payload, null when there is none
        token:
          description: Present only on authentication routes
          type:
            - string
            - 'null'
        trace_id:
          description: Present only when success is false
          type:
            - string
            - 'null'
      type: object
    ApiPage:
      description: >-
        A page of results: `data` holds the items. Ask another page with
        `?page=`
      properties:
        current_page:
          type: integer
          example: 1
        data:
          type: array
          items: {}
        per_page:
          type: integer
          example: 50
        total:
          type: integer
          example: 120
        last_page:
          type: integer
          example: 3
        from:
          type:
            - integer
            - 'null'
        to:
          type:
            - integer
            - 'null'
        first_page_url:
          type: string
        last_page_url:
          type: string
        next_page_url:
          type:
            - string
            - 'null'
        prev_page_url:
          type:
            - string
            - 'null'
        path:
          type: string
      type: object
    CampaignRecipient:
      properties:
        contact:
          properties:
            id:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
            identifier:
              description: >-
                Where the message went: phone number, or email address on the
                email channel
              type:
                - string
                - 'null'
          type: object
        channel:
          type: string
          example: whatsapp
        status:
          type: string
          enum:
            - waiting
            - queued
            - sending
            - sent
            - delivered
            - read
            - responded
            - failed
        last_event:
          type:
            - string
            - 'null'
          format: date-time
        failure:
          properties:
            reason:
              type: string
              enum:
                - no_whatsapp
                - invalid_number
                - email_refused
                - limit_reached
                - template_refused
                - insufficient_credit
                - other
            detail:
              description: The channel's message
              type:
                - string
                - 'null'
          type:
            - object
            - 'null'
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Company API key, sent as `Authorization: Bearer <key>`. Create it in the
        dashboard (Developer > API Keys) with the permissions the integration
        needs.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.