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

# List a campaign's leads

> The people enrolled in a campaign, as leads: where each is in the sequence, what they did (opened, clicked, replied, accepted an invitation), the A/B variants they were given and the account that first wrote to them. `search` matches a name or a company.

For the next page, send the page's `pagination.nextCursor` as `cursor`. Later pages keep the first page's `pageSize`; only a missing `nextCursor` marks the end. Send the same `search` with it.

Free. **Scope:** campaigns. Read-only keys may call it.



## OpenAPI

````yaml /openapi.json get /v1/campaigns/{campaignId}/leads
openapi: 3.1.0
info:
  title: outbound.dev API
  version: v1
  description: Find people and companies, and see what every call costs, with one API key.
servers:
  - url: https://api.outbound.dev
security: []
tags:
  - name: People
    description: >-
      Search people with filters, a saved search or a plain-language query,
      count matches and look up filter values.
  - name: Companies
    description: >-
      Search companies, count matches, name one company by its name, domain or
      LinkedIn page, and list its people.
  - name: Saved searches
    description: Keep a search under a title and run it again, for people or for companies.
  - name: Lists
    description: >-
      Keep people or companies in lists: create and change lists, page through
      their rows, and add or remove people.
  - name: Folders
    description: Group lists of one kind into folders.
  - name: Enrichment
    description: >-
      Find people's work emails and phone numbers: one person, a batch of
      people, or a list.
  - name: Jobs
    description: >-
      Long tasks a call started: their progress, what they produced and what
      they were charged, and stopping them.
  - name: Accounts
    description: >-
      Connect the mailboxes and LinkedIn seats that campaigns and the inbox send
      from, and look after them.
  - name: Campaigns
    description: >-
      Email and LinkedIn campaigns: their steps, the people they enroll, their
      queue of messages, templates, the knowledge hubs and writing styles AI
      steps are written from, the tracking domain their links go through, and
      the lists every campaign leaves out.
  - name: Inbox
    description: >-
      Read and answer the conversations of your mailboxes and LinkedIn seats,
      and send new messages and invitations.
  - name: Account
    description: >-
      The calling key and its organization, its rate limits, and revoking the
      key.
  - name: Billing
    description: The balance, the ledger of every change to it, and the price list.
  - name: Usage and requests
    description: >-
      Calls and spend by day, and the record of every request of the last 30
      days.
paths:
  /v1/campaigns/{campaignId}/leads:
    get:
      tags:
        - Campaigns
      summary: List a campaign's leads
      description: >-
        The people enrolled in a campaign, as leads: where each is in the
        sequence, what they did (opened, clicked, replied, accepted an
        invitation), the A/B variants they were given and the account that first
        wrote to them. `search` matches a name or a company.


        For the next page, send the page's `pagination.nextCursor` as `cursor`.
        Later pages keep the first page's `pageSize`; only a missing
        `nextCursor` marks the end. Send the same `search` with it.


        Free. **Scope:** campaigns. Read-only keys may call it.
      operationId: getCampaignsCampaignIdLeads
      parameters:
        - name: campaignId
          in: path
          required: true
          description: The campaign's id.
          schema:
            type: string
            minLength: 24
            maxLength: 24
            pattern: ^[0-9a-fA-F]+$
        - name: pageSize
          in: query
          required: false
          description: Items per page.
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
        - name: cursor
          in: query
          required: false
          description: >-
            The `pagination.nextCursor` of the page before. Later pages keep the
            first page's size.
          schema:
            type: string
            minLength: 1
            maxLength: 200
        - name: search
          in: query
          required: false
          description: Only leads whose name or company contains this text, in any case.
          schema:
            type: string
            minLength: 1
            maxLength: 200
      responses:
        '200':
          description: One page of the campaign's leads.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Charged-Usd:
              $ref: '#/components/headers/ChargedUsd'
            X-Balance-Usd:
              $ref: '#/components/headers/BalanceUsd'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - pagination
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                      properties:
                        id:
                          type: string
                          description: The lead's id, as the lead routes take it.
                        personId:
                          type: string
                        name:
                          type: string
                        email:
                          type: string
                        linkedinUrl:
                          type: string
                        companyName:
                          type: string
                        companyUrl:
                          type: string
                        status:
                          type: string
                          description: >-
                            `active`, `initializing`, `queued`, `paused`,
                            `paused_mailbox_disconnected`, `activation_failed`,
                            `stopped` or `completed`.
                        outcome:
                          type: string
                        sentSteps:
                          type: integer
                        totalSteps:
                          type: integer
                        openCount:
                          type: integer
                        clickCount:
                          type: integer
                        hasOpened:
                          type: boolean
                        hasClicked:
                          type: boolean
                        hasReplied:
                          type: boolean
                        hasConnected:
                          type: boolean
                          description: Accepted a LinkedIn invitation.
                        repliedInOtherCampaignAt:
                          type: string
                          format: date-time
                        repliedInOtherCampaignId:
                          type: string
                        firstMessageReceivedAt:
                          type: string
                          format: date-time
                        firstSentBy:
                          type: object
                          description: The account that first wrote to the lead.
                          properties:
                            name:
                              type: string
                            email:
                              type: string
                              description: >-
                                The mailbox, when the first message was an
                                email.
                            channel:
                              type: string
                              enum:
                                - email
                                - linkedin
                        arms:
                          type: array
                          description: >-
                            The variant each A/B split on the lead's path gave
                            it.
                          items:
                            type: object
                            properties:
                              splitStepId:
                                type: string
                              branchKey:
                                type: string
                                enum:
                                  - a
                                  - b
                  pagination:
                    type: object
                    required:
                      - pageSize
                      - total
                    properties:
                      pageSize:
                        type: integer
                      nextCursor:
                        type: string
                        description: >-
                          Send as `cursor` for the next page. Absent on the last
                          page.
                      total:
                        type: integer
                        description: Everything that matches, across every page.
              example:
                data:
                  - id: 6a1f0c2b9d4e8a7f3c5b2e33
                    personId: 6a1f0c2b9d4e8a7f3c5b2e22
                    name: Ana Costa
                    email: ana.costa@example.com
                    companyName: Northwind Freight
                    status: active
                    sentSteps: 1
                    totalSteps: 3
                    openCount: 2
                    clickCount: 0
                    hasOpened: true
                    hasClicked: false
                    hasReplied: false
                    hasConnected: false
                    firstSentBy:
                      name: Maya Fern
                      email: maya@fernway.co
                      channel: email
                    arms: []
                pagination:
                  pageSize: 25
                  total: 1
        '429':
          $ref: '#/components/responses/RateLimited'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
        - apiKey: []
components:
  headers:
    RequestId:
      description: The request's id. Quote it when you write to support.
      schema:
        type: string
        example: req_6a1f0c2b9d4e8a7f3c5b2e10
    ChargedUsd:
      description: What this call cost, in US dollars as an exact six-decimal string.
      schema:
        type: string
        example: '0.005000'
    BalanceUsd:
      description: >-
        The organization's balance after this call, in US dollars as an exact
        six-decimal string.
      schema:
        type: string
        example: '9.995000'
    RateLimitLimit:
      description: >-
        The calls allowed in the window of the route's limit with the fewest
        calls left.
      schema:
        type: integer
        example: 20
    RateLimitRemaining:
      description: The calls left in that window.
      schema:
        type: integer
        example: 19
    RateLimitReset:
      description: Seconds until that window resets.
      schema:
        type: integer
        example: 42
    RetryAfter:
      description: Seconds to wait before calling again.
      schema:
        type: integer
        example: 42
  responses:
    RateLimited:
      description: >-
        Too many calls. Wait the seconds in Retry-After, then call again. When
        the limit reached does not say when it resets, such as a mail provider's
        own limit on a mailbox, Retry-After is 60. The RateLimit headers
        describe this API's own limits, so they come only with a 429 one of
        those gave. The body is empty.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
    Error:
      description: The request was refused. The body names the reason in `error.code`.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: >-
        Something failed on our side and nothing was charged. Retry with
        backoff; quote X-Request-Id if it persists. The body is empty.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - doc_url
          properties:
            code:
              type: string
              description: >-
                Stable and machine-readable: branch on it. It never changes
                meaning.
            message:
              type: string
              description: >-
                A human-readable explanation for logs. It may be reworded at any
                time.
            param:
              type: string
              description: The request field the error is about, when there is one.
            doc_url:
              type: string
              description: The code's entry in the errors reference.
            request_id:
              type: string
              description: >-
                The request's id, as in the X-Request-Id header. Quote it to
                support.
      example:
        error:
          code: insufficient_balance
          message: Your balance cannot cover this call. Add funds and try again.
          doc_url: https://docs.outbound.dev/errors#insufficient_balance
          request_id: req_6a1f0c2b9d4e8a7f3c5b2e10
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from the console, starting `ob_live_`, sent as
        `Authorization: Bearer <key>`.

````

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