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

# Retrieve a campaign



## OpenAPI

````yaml /api-reference/openapi.json get /v1/campaigns/{campaign_id}
openapi: 3.1.0
info:
  description: >-
    The Sailer REST API for CRM, conversations, and campaigns.


    **Authentication.** Send a scoped token as `Authorization: Bearer
    sk_live_...`.

    Tokens are workspace-scoped; the workspace is implied by the token, so no

    tenant header is needed. A workspace administrator creates and revokes them;

    the secret is shown once at creation and cannot be recovered afterwards.


    **Pagination.** Collections return `{data, meta, links}`. Follow
    `links.next`

    until it is `null`; treat the cursor as opaque.


    **Errors.** Every non-2xx response is `{"error": {...}}` with a stable
    `code`.

    Quote `error.request_id` when contacting support.


    **Custom fields.** Workspace-defined fields appear under `custom_fields`,
    keyed

    by `field_key`. Read a record to see which keys a workspace uses; a
    dedicated

    field-discovery endpoint is not part of this release.
  title: Sailer API
  version: 1.0.0
servers:
  - url: https://api.chatsailer.com
security:
  - SailerApiToken: []
tags:
  - description: Token introspection and workspace capabilities.
    name: Meta
  - description: >-
      People you talk to. Called *leads* in older Sailer surfaces; `contact` is
      the current name.
    name: Contacts
  - description: Companies that contacts belong to (B2B accounts).
    name: Organizations
  - description: Opportunities moving through a pipeline.
    name: Deals
  - description: Pipelines and their stages.
    name: Pipelines
  - description: Field definitions, including custom fields.
    name: Fields
  - description: Free-text annotations on CRM records.
    name: Notes
  - description: Scheduled and logged CRM activities.
    name: Activities
  - description: Per-entity label catalogs.
    name: Tags
  - description: Message threads with contacts, across every channel.
    name: Conversations
  - description: Outbound campaigns and their participants.
    name: Campaigns
paths:
  /v1/campaigns/{campaign_id}:
    get:
      tags:
        - Campaigns
      summary: Retrieve a campaign
      operationId: get_campaign
      parameters:
        - in: path
          name: campaign_id
          required: true
          schema:
            description: Unique identifier for a campaign.
            examples:
              - camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4
            pattern: ^camp_[0-9a-f]{32}$
            title: Campaign Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - SailerApiToken: []
components:
  schemas:
    Campaign:
      description: An outbound campaign.
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        id:
          description: Unique identifier for a campaign.
          examples:
            - camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4
          pattern: ^camp_[0-9a-f]{32}$
          title: Id
          type: string
        instructions:
          anyOf:
            - type: string
            - type: 'null'
          description: How the AI should continue a conversation after a reply.
          title: Instructions
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        object:
          const: campaign
          default: campaign
          title: Object
          type: string
        status:
          $ref: '#/components/schemas/CampaignStatus'
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - status
        - created_at
        - updated_at
      title: Campaign
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CampaignStatus:
      enum:
        - scheduled
        - running
        - paused
        - completed
        - draft
      title: CampaignStatus
      type: string
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    SailerApiToken:
      description: >-
        A workspace API token. Create one in Settings → API. Send it as
        `Authorization: Bearer sk_live_...`.
      scheme: bearer
      type: http

````