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

# Get a campaign

> The full campaign record, including the spec it was published from, the per-step execution plan with each step's status, and the launch audit stamp.



## OpenAPI

````yaml /openapi.json get /api/campaigns/{id}
openapi: 3.1.0
info:
  title: Revcenter API
  description: >-
    Search, enrich, and activate people and companies. Two authentication
    surfaces share one host: the bearer-token API under `/v1` for
    server-to-server and agent use, and the workspace-session API under `/api`
    that the Revcenter app itself runs on.
  version: '2026-08-12'
servers:
  - url: https://api.revcenter.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Search
    description: Web search, search runs, results, exports, and shareable shortlists.
  - name: People
    description: Person search, profile enrichment, and the workspace contact pool.
  - name: Companies
    description: Company search, company enrichment, and org-chart people.
  - name: Campaigns
    description: Plan, publish, and launch outbound sequences on Smartlead and HeyReach.
  - name: Account
    description: Health, usage totals, and cost events.
paths:
  /api/campaigns/{id}:
    get:
      tags:
        - Campaigns
      summary: Get a campaign
      description: >-
        The full campaign record, including the spec it was published from, the
        per-step execution plan with each step's status, and the launch audit
        stamp.
      operationId: getCampaign
      parameters:
        - $ref: '#/components/parameters/CampaignId'
      responses:
        '200':
          description: The campaign.
          content:
            application/json:
              schema:
                type: object
                properties:
                  campaign:
                    $ref: '#/components/schemas/Campaign'
        '401':
          $ref: '#/components/responses/AppUnauthorized'
        '404':
          $ref: '#/components/responses/AppNotFound'
        '502':
          $ref: '#/components/responses/AppUpstreamError'
      security:
        - sessionCookie: []
components:
  parameters:
    CampaignId:
      name: id
      in: path
      required: true
      description: The campaign ID.
      schema:
        type: string
        format: uuid
  schemas:
    Campaign:
      allOf:
        - $ref: '#/components/schemas/CampaignSummary'
        - type: object
          properties:
            spec:
              $ref: '#/components/schemas/CampaignSpec'
            scan_ids:
              type: array
              items:
                type: string
                format: uuid
            steps:
              type: array
              description: Execution plan with live per-step status.
              items:
                type: object
                properties:
                  key:
                    type: string
                    examples:
                      - start
                  label:
                    type: string
                  status:
                    type: string
                    enum:
                      - pending
                      - ok
                      - failed
                  detail:
                    type: string
            launched_at:
              type:
                - string
                - 'null'
              format: date-time
            launched_by:
              type:
                - string
                - 'null'
              description: Email of whoever clicked go-live.
    CampaignSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        provider:
          type: string
          enum:
            - smartlead
            - heyreach
        name:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/CampaignStatus'
        leads_pushed:
          type:
            - integer
            - 'null'
        external_campaign_id:
          type:
            - string
            - 'null'
          description: The campaign's ID at the provider.
        error:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
    CampaignSpec:
      type: object
      description: >-
        The reviewable campaign plan. Produced by the plan endpoint, sent back
        verbatim to publish.
      properties:
        platform:
          type: string
          enum:
            - smartlead
            - heyreach
          description: >-
            `smartlead` sends email and needs leads with emails. `heyreach`
            sends LinkedIn and needs leads with profile URLs.
        name:
          type: string
        steps:
          type: array
          minItems: 1
          description: The sequence, in order.
          items:
            type: object
            properties:
              subject:
                type: string
                description: Email only.
              body:
                type: string
              delayDays:
                type: integer
                description: Wait before this step.
            additionalProperties: true
      additionalProperties: true
    AppError:
      type: object
      description: >-
        The error shape used by every `/api` endpoint. Flatter than the `/v1`
        shape, and `code` appears only where the UI branches on it.
      properties:
        error:
          type: string
        code:
          type: string
          examples:
            - search_unavailable
    CampaignStatus:
      type: string
      enum:
        - publishing
        - awaiting_launch
        - live
        - failed
      description: >-
        Publishing stages everything and stops at `awaiting_launch`. Only an
        explicit launch call moves it to `live`.
  responses:
    AppUnauthorized:
      description: >-
        Not signed in, no active workspace, or the account lacks the role this
        action needs. A frozen account gets `403` with code `frozen`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            signIn:
              value:
                error: Sign in required
    AppNotFound:
      description: >-
        The record does not exist, or belongs to another workspace. The two are
        deliberately indistinguishable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            notFound:
              value:
                error: Scan not found
    AppUpstreamError:
      description: A downstream service or the database failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            upstream:
              value:
                error: Spec extraction failed
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Revcenter API key: `Authorization: Bearer rvc_live_...`. Keys are
        scoped, rate limited per key, and metered per workspace.
    sessionCookie:
      type: apiKey
      in: cookie
      name: session
      description: >-
        A signed-in workspace session, sent as a browser cookie. Requests must
        include credentials, and act on the session's active workspace.

````