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

# list a campaign's contacts

> the campaign's contacts in list order, each with where it stands: `pending`, `dialing`, `in_progress`, `retry_waiting`, `completed`, `failed` or `skipped`.



## OpenAPI

````yaml /openapi.json get /v1/campaigns/{campaign_id}/contacts
openapi: 3.1.0
info:
  title: silk api
  version: 1.0.0
  description: >-
    rumik ai's speech api. synthesize speech with the expressive `muga` model or
    the faster `mulberry` model over http or a streaming websocket session, run
    conversational voice agents over webrtc, a realtime pcm socket or the phone,
    and manage everything the agents playground does — agents, voices,
    variables, tools, phone numbers, sip trunks and outbound calls — with the
    same api key.
  contact:
    name: rumik ai
    url: https://rumik.ai
servers:
  - url: https://silk-api.rumik.ai
    description: production
security:
  - bearerAuth: []
tags:
  - name: speech
    description: text-to-speech over HTTP and WebSocket.
  - name: voice agents
    description: start calls with a deployed agent from your own app.
  - name: agents
    description: build, configure, deploy and inspect your agents.
  - name: calls
    description: place outbound phone calls and read call history.
  - name: voices
    description: the voices, languages and styles an agent may use.
  - name: variables
    description: account-wide `{name}` prompt variables and their defaults.
  - name: tools
    description: HTTP tools agents call before or during a call.
  - name: phone numbers
    description: 'numbers rented through rumik: search, rent, connect, release.'
  - name: sip trunks
    description: bring your own numbers over SIP.
  - name: campaign audiences
    description: >-
      the contact lists (CSV uploads) a campaign calls, and the columns its
      agent gets.
  - name: campaigns
    description: >-
      outbound campaigns: an agent calling an audience from your own number,
      with retries and a start time — and every call's transcript and recording.
paths:
  /v1/campaigns/{campaign_id}/contacts:
    get:
      tags:
        - campaigns
      summary: list a campaign's contacts
      description: >-
        the campaign's contacts in list order, each with where it stands:
        `pending`, `dialing`, `in_progress`, `retry_waiting`, `completed`,
        `failed` or `skipped`.
      operationId: listCampaignContacts
      parameters:
        - name: campaign_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: the campaign's id.
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/CampaignContactStatus'
              - type: 'null'
          description: only contacts in this state.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
          description: page number, from 1.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
          description: page size (1–200, default 50).
      responses:
        '200':
          description: ok.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignContactList'
              examples:
                default:
                  value:
                    items:
                      - id: 01a0d276-81a4-73b5-e021-3c4d5e6f7081
                        rowNumber: 1
                        phoneNumber: '+919876543210'
                        data:
                          name: Asha
                          city: Pune
                          mobile: '9876543210'
                        status: completed
                        attempts: 1
                        nextAttemptAt: null
                        lastRunId: 01a05b4d-b1ad-7be0-8d29-04b2fd7e7dca
                        lastEndReason: customer_ended
                        lastError: null
                        completedAt: '2026-10-01T09:08:41Z'
                        updatedAt: '2026-10-01T09:08:41Z'
                    count: 120
                    page: 1
                    totalPages: 3
        '401':
          description: >-
            `unauthorized` — key missing, malformed, unknown, revoked or
            expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  value:
                    error: Invalid API key
                    code: unauthorized
        '403':
          description: '`forbidden_scope` — the key was created without the `agent` scope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                forbidden_scope:
                  value:
                    error: This API key lacks the 'agent' scope
                    code: forbidden_scope
        '404':
          description: '`campaign_not_found` — no such campaign on this account.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                campaign_not_found:
                  value:
                    error: Campaign not found
                    code: campaign_not_found
        '429':
          description: >-
            `rate_limited` — the key's per-minute budget is spent. `Retry-After`
            says how long to wait; the body carries `limit` and `current`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rate_limited:
                  value:
                    error: Rate limit exceeded
                    code: rate_limited
                    limit: 100
                    current: 101
          headers:
            Retry-After:
              description: seconds to wait before retrying (per-key rate limit only).
              schema:
                type: integer
components:
  schemas:
    CampaignContactStatus:
      type: string
      enum:
        - pending
        - dialing
        - in_progress
        - retry_waiting
        - completed
        - failed
        - skipped
      title: CampaignContactStatus
      description: >-
        Where one contact of a campaign is in its dialling lifecycle.


        ``PENDING`` has never been dialled; ``DIALING`` is claimed by the dialer

        (the call is being placed); ``IN_PROGRESS`` has a live run;
        ``RETRY_WAITING``

        is due again at ``next_attempt_at``; ``COMPLETED`` had a conversation;

        ``FAILED`` never connected within the retry budget; ``SKIPPED`` was left

        undialled because the campaign was cancelled.
    CampaignContactList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/CampaignContact'
          type: array
        count:
          type: integer
        page:
          type: integer
        totalPages:
          type: integer
      type: object
      required:
        - items
        - count
        - page
        - totalPages
      title: CampaignContactList
    Error:
      type: object
      properties:
        error:
          type: string
          description: human-readable error message.
        code:
          type: string
          description: machine-readable error code.
    CampaignContact:
      properties:
        id:
          type: string
          format: uuid
        rowNumber:
          type: integer
        phoneNumber:
          type: string
        data:
          type: object
          additionalProperties:
            type: string
        status:
          type: string
        attempts:
          type: integer
        nextAttemptAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        lastRunId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        lastEndReason:
          anyOf:
            - type: string
            - type: 'null'
        lastError:
          anyOf:
            - type: string
            - type: 'null'
        completedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        updatedAt:
          type: string
          format: date-time
      type: object
      required:
        - id
        - rowNumber
        - phoneNumber
        - data
        - status
        - attempts
        - nextAttemptAt
        - lastRunId
        - lastEndReason
        - lastError
        - completedAt
        - updatedAt
      title: CampaignContact
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        your rumik api key, e.g. `rk_live_...`. create one in the rumik
        dashboard.

````

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