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

# List campaign recipients

> Returns a cursor-paginated slice of the campaign's recipients, each with its latest delivery status (queued, sent, delivered, failed, or read). Use it to render a delivery-report table or to power the "Resend to Failed" flow: `pagination.failed_count` is the campaign-wide failed total (not just the loaded page) and `pagination.total_count` is the authoritative recipient count. Page with `limit` (1-200, default 50) and the opaque `cursor` returned as `pagination.next_cursor`.



## OpenAPI

````yaml /openapi.yaml get /api/v1/campaigns/{id}/recipients
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/campaigns/{id}/recipients:
    get:
      tags:
        - Campaigns
      summary: List campaign recipients
      description: >-
        Returns a cursor-paginated slice of the campaign's recipients, each with
        its latest delivery status (queued, sent, delivered, failed, or read).
        Use it to render a delivery-report table or to power the "Resend to
        Failed" flow: `pagination.failed_count` is the campaign-wide failed
        total (not just the loaded page) and `pagination.total_count` is the
        authoritative recipient count. Page with `limit` (1-200, default 50) and
        the opaque `cursor` returned as `pagination.next_cursor`.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          in: query
          name: limit
          required: false
        - schema:
            type: string
          in: query
          name: cursor
          required: false
      responses:
        '200':
          description: >-
            Paginated slice of campaign recipients with per-recipient delivery
            status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                      properties:
                        contact_id:
                          type: string
                        address:
                          type: string
                          description: >-
                            Destination phone number or email for this
                            recipient.
                        status:
                          type: string
                          description: >-
                            Latest per-recipient delivery status: queued, sent,
                            delivered, failed, or read.
                  pagination:
                    type: object
                    properties:
                      has_more:
                        type: boolean
                      next_cursor:
                        type: string
                        description: >-
                          Opaque cursor for the next page; null on the last
                          page.
                      limit:
                        type: integer
                      total_count:
                        type: integer
                        description: >-
                          Campaign-wide recipient count over the base filter,
                          independent of the cursor.
                      failed_count:
                        type: integer
                        description: >-
                          Campaign-wide count of recipients whose latest message
                          failed.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '404':
          description: Campaign not found.
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````