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

# List or get campaigns

> List campaigns, or pass `id` for one. Add `include=preflight` for the launch checks of that campaign, or `config.*` for its settings. `type` folder or template lists campaign folders or ready-made templates instead.



## OpenAPI

````yaml /openapi.json get /api/v1/public/campaigns
openapi: 3.1.0
info:
  description: >-
    Customer-facing API for managing outreach, leads, conversations, voice
    agents, knowledge bases, analytics, and webhooks.
  title: Sendora Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.sendora.ai
security: []
tags:
  - description: Leads, lead lists, importing, enriching and finding new prospects.
    name: Leads
  - description: Build, run and measure outreach, and enroll leads.
    name: Campaigns
  - description: Read and send messages, and manage who must not be contacted.
    name: Conversations
  - description: >-
      Voice and chat agents, their tools, knowledge bases, voices and website
      widgets.
    name: Agents
  - description: >-
      Start calls, and manage phone numbers, SMS registration, sending accounts
      and email domains.
    name: Calls and numbers
  - description: Webhooks, jobs, analytics and the Copilot assistant.
    name: Platform
  - description: Manage client workspaces, plans and branding.
    name: Agency
paths:
  /api/v1/public/campaigns:
    get:
      tags:
        - Campaigns
      summary: List or get campaigns
      description: >-
        List campaigns, or pass `id` for one. Add `include=preflight` for the
        launch checks of that campaign, or `config.*` for its settings. `type`
        folder or template lists campaign folders or ready-made templates
        instead.
      operationId: list_or_get_campaigns_api_v1_public_campaigns_get
      parameters:
        - description: >-
            campaign (the default), folder (campaign folders, with a campaign
            count each) or template (ready-made campaigns; filter with slug, q,
            category, channel, limit, offset).
          in: query
          name: type
          required: false
          schema:
            default: campaign
            description: >-
              campaign (the default), folder (campaign folders, with a campaign
              count each) or template (ready-made campaigns; filter with slug,
              q, category, channel, limit, offset).
            enum:
              - campaign
              - folder
              - template
            title: Type
            type: string
        - description: 'The campaign''s id: the `id` from the list for this resource.'
          in: query
          name: id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Return this one campaign.
            title: Id
        - description: >-
            Comma separated extras: preflight (launch checks for one campaign),
            folders, and config.journey, config.ai, config.channels (sending
            accounts and tracking per channel), config.versions (saved workflow
            versions), config.triggers, config.condition_fields,
            config.dialer_eta (a campaign's settings; add node_id for one step's
            variables).
          in: query
          name: include
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Comma separated extras: preflight (launch checks for one
              campaign), folders, and config.journey, config.ai, config.channels
              (sending accounts and tracking per channel), config.versions
              (saved workflow versions), config.triggers,
              config.condition_fields, config.dialer_eta (a campaign's settings;
              add node_id for one step's variables).
            title: Include
        - description: 'With a config.* include: a step id, to add that step''s variables.'
          in: query
          name: node_id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'With a config.* include: a step id, to add that step''s variables.'
            title: Node Id
        - description: >-
            With config.versions: also return this saved workflow version with
            its graph.
          in: query
          name: version_no
          required: false
          schema:
            anyOf:
              - minimum: 1
                type: integer
              - type: 'null'
            description: >-
              With config.versions: also return this saved workflow version with
              its graph.
            title: Version No
        - description: draft, running, paused, completed or cancelled.
          in: query
          name: status
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: draft, running, paused, completed or cancelled.
            title: Status
        - in: query
          name: search
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Search
        - in: query
          name: page
          required: false
          schema:
            default: 1
            minimum: 1
            title: Page
            type: integer
        - in: query
          name: per_page
          required: false
          schema:
            default: 50
            maximum: 200
            minimum: 1
            title: Per Page
            type: integer
        - in: header
          name: X-API-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
        - in: header
          name: Authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/CampaignList'
                  - $ref: '#/components/schemas/CampaignDetail'
                title: Response List Or Get Campaigns Api V1 Public Campaigns Get
          description: Successful Response
        '401':
          description: The X-API-Key header is missing, invalid, expired, or revoked.
        '402':
          description: >-
            The workspace is suspended for billing, or the request would exceed
            a plan or usage limit.
        '403':
          description: >-
            The key is valid but lacks the required scope, or the workspace has
            no active plan, lacks the entitlement, or has this feature turned
            off or view-only.
        '410':
          description: The workspace behind this key has been deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          description: >-
            An unexpected Sendora error occurred. Retry only if the operation is
            safe to repeat.
        '503':
          description: >-
            An entitlement or billing check is temporarily unavailable. Retry
            after the Retry-After interval.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - label: cURL
          lang: bash
          source: >-
            curl -X GET 'https://api.sendora.ai/api/v1/public/campaigns' -H
            "X-API-Key: $SENDORA_API_KEY"
        - label: Python
          lang: python
          source: |-
            import requests

            url = 'https://api.sendora.ai/api/v1/public/campaigns'
            headers = {'X-API-Key': '$SENDORA_API_KEY'}
            response = requests.get(url, headers=headers)
            response.raise_for_status()
            print(response.json())
        - label: JavaScript
          lang: javascript
          source: >-
            const response = await
            fetch("https://api.sendora.ai/api/v1/public/campaigns", {
              method: "GET",
              headers: { 'X-API-Key': process.env.SENDORA_API_KEY },
            });

            if (!response.ok) throw new Error(await response.text());

            console.log(await response.json());
        - label: Go
          lang: go
          source: >-
            req, err := http.NewRequest("GET",
            "https://api.sendora.ai/api/v1/public/campaigns", nil)

            if err != nil { log.Fatal(err) }

            req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))

            resp, err := http.DefaultClient.Do(req)

            if err != nil { log.Fatal(err) }

            defer resp.Body.Close()
components:
  schemas:
    CampaignList:
      properties:
        campaigns:
          description: Campaigns returned by the Sendora API.
          items:
            $ref: '#/components/schemas/CampaignListItem'
          title: Campaigns
          type: array
        folders:
          anyOf:
            - items:
                type: object
              type: array
            - type: 'null'
          description: Present with include=folders.
          title: Folders
        summary:
          anyOf:
            - $ref: '#/components/schemas/CampaignListSummary'
            - type: 'null'
          description: Summary returned by the Sendora API.
        total:
          description: Total returned by the Sendora API.
          title: Total
          type: integer
      required:
        - campaigns
        - total
      title: CampaignList
      type: object
    CampaignDetail:
      properties:
        build_mode:
          default: linear
          description: Build mode returned by the Sendora API.
          enum:
            - linear
            - advanced
          title: Build Mode
          type: string
        build_mode_reason:
          anyOf:
            - type: string
            - type: 'null'
          description: Build mode reason returned by the Sendora API.
          title: Build Mode Reason
        channels:
          default: []
          description: Channels returned by the Sendora API.
          items:
            type: string
          title: Channels
          type: array
        connect_rate:
          default: 0
          description: Connect rate returned by the Sendora API.
          title: Connect Rate
          type: number
        contacted_count:
          default: 0
          description: Contacted count returned by the Sendora API.
          title: Contacted Count
          type: integer
        created_at:
          description: Created at returned by the Sendora API.
          format: date-time
          title: Created At
          type: string
        created_from_template_slug:
          anyOf:
            - type: string
            - type: 'null'
          description: Created from template slug returned by the Sendora API.
          title: Created From Template Slug
        enrollment:
          anyOf:
            - type: object
            - type: 'null'
          description: >-
            Present when leads were enrolled in this call: enrolled, skipped and
            total_requested.
          title: Enrollment
        folder_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The folder to place the campaign in: an `id` from List or get
            campaigns. Leave empty for no folder.
          title: Folder Id
        id:
          description: The campaign's id. Pass it to any endpoint that takes `campaign_id`.
          title: Id
          type: string
        inbound_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The voice agent that answers incoming calls: an `id` from List or
            get agents.
          title: Inbound Agent Id
        inbound_agent_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Inbound agent name returned by the Sendora API.
          title: Inbound Agent Name
        lead_count:
          default: 0
          description: Lead count returned by the Sendora API.
          title: Lead Count
          type: integer
        lead_list_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            A lead list's id: the `id` from List or read lead collections (type
            list).
          title: Lead List Id
        meeting_count:
          default: 0
          description: Meeting count returned by the Sendora API.
          title: Meeting Count
          type: integer
        name:
          description: Name returned by the Sendora API.
          title: Name
          type: string
        preflight:
          anyOf:
            - type: object
            - type: 'null'
          description: >-
            Launch checks: ok, lead_count, total_nodes, errors and warnings.
            Present with include=preflight.
          title: Preflight
        reply_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The voice agent that handles replies from leads in this campaign: an
            `id` from List or get agents. When empty, the workspace's first
            agent is used.
          title: Reply Agent Id
        reply_count:
          default: 0
          description: Reply count returned by the Sendora API.
          title: Reply Count
          type: integer
        reply_mode:
          default: 'off'
          description: Reply mode returned by the Sendora API.
          enum:
            - 'off'
            - draft
            - auto
          title: Reply Mode
          type: string
        reply_note:
          default: ''
          description: Reply note returned by the Sendora API.
          title: Reply Note
          type: string
        smoke_test_active:
          default: false
          description: Smoke test active returned by the Sendora API.
          title: Smoke Test Active
          type: boolean
        smoke_test_started_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: Smoke test started at returned by the Sendora API.
          title: Smoke Test Started At
        status:
          description: Status returned by the Sendora API.
          title: Status
          type: string
        updated_at:
          description: Updated at returned by the Sendora API.
          format: date-time
          title: Updated At
          type: string
        variable_defaults:
          additionalProperties:
            type: string
          default: {}
          description: Variable defaults returned by the Sendora API.
          title: Variable Defaults
          type: object
        warnings:
          description: Warnings returned by the Sendora API.
          items:
            type: string
          title: Warnings
          type: array
        workflow:
          anyOf:
            - $ref: '#/components/schemas/CampaignWorkflow-Output'
            - type: 'null'
          description: Workflow returned by the Sendora API.
        workflow_ui_json:
          anyOf:
            - type: object
            - type: 'null'
          description: Workflow ui json returned by the Sendora API.
          title: Workflow Ui Json
      required:
        - id
        - name
        - status
        - created_at
        - updated_at
      title: CampaignDetail
      type: object
    HTTPValidationError:
      properties:
        detail:
          description: Detail returned by the Sendora API.
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      required: []
      title: HTTPValidationError
      type: object
    CampaignListItem:
      description: Compact campaign row; workflow graphs belong to the detail endpoint.
      properties:
        channels:
          description: Channels returned by the Sendora API.
          items:
            type: string
          title: Channels
          type: array
        connect_rate:
          default: 0
          description: Connect rate returned by the Sendora API.
          title: Connect Rate
          type: number
        contacted_count:
          default: 0
          description: Contacted count returned by the Sendora API.
          title: Contacted Count
          type: integer
        created_at:
          description: Created at returned by the Sendora API.
          format: date-time
          title: Created At
          type: string
        folder_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The folder to place the campaign in: an `id` from List or get
            campaigns. Leave empty for no folder.
          title: Folder Id
        health:
          $ref: '#/components/schemas/CampaignListHealth'
          description: Health returned by the Sendora API.
        id:
          description: The campaign's id. Pass it to any endpoint that takes `campaign_id`.
          title: Id
          type: string
        lead_count:
          default: 0
          description: Lead count returned by the Sendora API.
          title: Lead Count
          type: integer
        lead_list_attached:
          default: false
          description: Lead list attached returned by the Sendora API.
          title: Lead List Attached
          type: boolean
        meeting_count:
          default: 0
          description: Meeting count returned by the Sendora API.
          title: Meeting Count
          type: integer
        name:
          description: Name returned by the Sendora API.
          title: Name
          type: string
        readiness_warnings:
          description: Readiness warnings returned by the Sendora API.
          items:
            type: string
          title: Readiness Warnings
          type: array
        reply_count:
          default: 0
          description: Reply count returned by the Sendora API.
          title: Reply Count
          type: integer
        status:
          description: Status returned by the Sendora API.
          title: Status
          type: string
        workflow_step_count:
          default: 0
          description: Workflow step count returned by the Sendora API.
          title: Workflow Step Count
          type: integer
      required:
        - id
        - name
        - status
        - created_at
      title: CampaignListItem
      type: object
    CampaignListSummary:
      properties:
        active_campaigns:
          default: 0
          description: Active campaigns returned by the Sendora API.
          title: Active Campaigns
          type: integer
        cancelled_campaigns:
          default: 0
          description: Cancelled campaigns returned by the Sendora API.
          title: Cancelled Campaigns
          type: integer
        completed_campaigns:
          default: 0
          description: Completed campaigns returned by the Sendora API.
          title: Completed Campaigns
          type: integer
        draft_campaigns:
          default: 0
          description: Draft campaigns returned by the Sendora API.
          title: Draft Campaigns
          type: integer
        failed_campaigns:
          default: 0
          description: Failed campaigns returned by the Sendora API.
          title: Failed Campaigns
          type: integer
        paused_campaigns:
          default: 0
          description: Paused campaigns returned by the Sendora API.
          title: Paused Campaigns
          type: integer
        total_campaigns:
          default: 0
          description: Total campaigns returned by the Sendora API.
          title: Total Campaigns
          type: integer
        total_leads:
          default: 0
          description: Total leads returned by the Sendora API.
          title: Total Leads
          type: integer
        total_meetings:
          default: 0
          description: Total meetings returned by the Sendora API.
          title: Total Meetings
          type: integer
      required: []
      title: CampaignListSummary
      type: object
    CampaignWorkflow-Output:
      properties:
        name:
          description: Name returned by the Sendora API.
          maxLength: 200
          minLength: 1
          title: Name
          type: string
        nodes:
          description: Nodes returned by the Sendora API.
          items:
            $ref: '#/components/schemas/CampaignNode'
          maxItems: 200
          minItems: 1
          title: Nodes
          type: array
        version:
          default: '1.0'
          description: Version returned by the Sendora API.
          title: Version
          type: string
      required:
        - name
        - nodes
      title: CampaignWorkflow
      type: object
    ValidationError:
      properties:
        loc:
          description: Loc returned by the Sendora API.
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          description: Msg returned by the Sendora API.
          title: Message
          type: string
        type:
          description: Type returned by the Sendora API.
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    CampaignListHealth:
      properties:
        misconfigured_count:
          default: 0
          description: Misconfigured count returned by the Sendora API.
          title: Misconfigured Count
          type: integer
        orphan_count:
          default: 0
          description: Orphan count returned by the Sendora API.
          title: Orphan Count
          type: integer
        timing_risk_count:
          default: 0
          description: Timing risk count returned by the Sendora API.
          title: Timing Risk Count
          type: integer
        total:
          default: 0
          description: Total returned by the Sendora API.
          title: Total
          type: integer
      required: []
      title: CampaignListHealth
      type: object
    CampaignNode:
      properties:
        config:
          description: Config returned by the Sendora API.
          title: Config
          type: object
        id:
          description: >-
            The step's id inside this workflow. Transitions refer to steps by
            this id.
          maxLength: 100
          minLength: 1
          title: Id
          type: string
        transitions:
          description: Transitions returned by the Sendora API.
          items:
            $ref: '#/components/schemas/Transition'
          title: Transitions
          type: array
        type:
          description: Type returned by the Sendora API.
          enum:
            - voice_call
            - send_email
            - send_sms
            - linkedin_connection
            - linkedin_message
            - linkedin_inmail
            - whatsapp_message
            - wait
            - condition
            - route
            - branch
            - ai_personalization
            - ai_decision
            - enrich
            - update_pipeline
            - create_task
            - human_approval
            - escalation
            - crm_update
            - send_webhook
            - trigger
          title: Type
          type: string
        variants:
          anyOf:
            - items:
                $ref: '#/components/schemas/NodeVariant'
              type: array
            - type: 'null'
          description: Variants returned by the Sendora API.
          title: Variants
      required:
        - id
        - type
        - config
      title: CampaignNode
      type: object
    Transition:
      properties:
        next:
          description: Next returned by the Sendora API.
          minLength: 1
          title: Next
          type: string
        'on':
          description: On returned by the Sendora API.
          minLength: 1
          title: 'On'
          type: string
      required:
        - 'on'
        - next
      title: Transition
      type: object
    NodeVariant:
      description: A single A/B variant on a campaign node.
      properties:
        config:
          description: Config returned by the Sendora API.
          title: Config
          type: object
        is_control:
          default: false
          description: Is control returned by the Sendora API.
          title: Is Control
          type: boolean
        variant_key:
          description: Variant key returned by the Sendora API.
          maxLength: 100
          minLength: 1
          pattern: ^[a-z0-9_\-]+$
          title: Variant Key
          type: string
        weight:
          default: 1
          description: Weight returned by the Sendora API.
          maximum: 100
          minimum: 0
          title: Weight
          type: integer
      required:
        - variant_key
        - config
      title: NodeVariant
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Customer API key created in the Sendora dashboard.
      in: header
      name: X-API-Key
      type: apiKey

````

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