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

# List outreach campaigns of every kind on the Campaigns page, each with its kind (archived ones on request)

> List outreach campaigns of every kind on the Campaigns page, each with its kind (archived ones on request).



## OpenAPI

````yaml /api-reference/openapi.json get /campaigns
openapi: 3.1.0
info:
  title: Dench API
  version: 1.0.0
  description: >-
    Versioned Dench workspace API. The operation registry is shared with the
    Dench CLI parity layer, so every CLI command maps to an endpoint here.
servers:
  - url: https://www.dench.com/api/v1
security: []
tags:
  - name: agent-config
    description: Agent Config operations.
  - name: apps
    description: Apps operations.
  - name: auth
    description: Auth operations.
  - name: billing
    description: Billing operations.
  - name: browser
    description: Browser operations.
  - name: campaigns
    description: Campaigns operations.
  - name: chat
    description: Chat operations.
  - name: crm
    description: Crm operations.
  - name: email
    description: Email operations.
  - name: environments
    description: Environments operations.
  - name: files
    description: Files operations.
  - name: gateway
    description: Gateway operations.
  - name: lists
    description: Lists operations.
  - name: local
    description: Local operations.
  - name: meetings
    description: Meetings operations.
  - name: members
    description: Members operations.
  - name: memory
    description: Memory operations.
  - name: meta
    description: Meta operations.
  - name: notifications
    description: Notifications operations.
  - name: routines
    description: Routines operations.
  - name: secrets
    description: Secrets operations.
  - name: settings
    description: Settings operations.
  - name: workspace
    description: Workspace operations.
paths:
  /campaigns:
    get:
      tags:
        - campaigns
      summary: >-
        List outreach campaigns of every kind on the Campaigns page, each with
        its kind (archived ones on request)
      description: >-
        List outreach campaigns of every kind on the Campaigns page, each with
        its kind (archived ones on request).
      operationId: campaigns_list
      parameters:
        - name: withReferences
          in: query
          required: false
          schema:
            description: >-
              Include bounded navigation references. Array reads return {data,
              references, referenceCoverage}; existing result envelopes keep
              their fields.
            type: boolean
          description: >-
            Include bounded navigation references. Array reads return {data,
            references, referenceCoverage}; existing result envelopes keep their
            fields.
        - name: includeArchived
          in: query
          required: false
          schema:
            description: Include archived campaigns.
            type: boolean
          description: Include archived campaigns.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                anyOf:
                  - type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            _id:
                              type: string
                            name:
                              type: string
                            status:
                              type: string
                              enum:
                                - draft
                                - active
                                - paused
                                - completed
                                - archived
                              description: Campaign lifecycle status.
                            stopOnReply:
                              type: boolean
                            emailMailboxAccountIds:
                              description: >-
                                Campaign email sender pool: up to 50
                                emailMailboxAccounts ids both you and the
                                campaign owner may use. Omit to preserve
                                existing configuration; [] clears the pool. A
                                person's sender stays fixed for their
                                conversation. Launch validates sender
                                availability.
                              maxItems: 50
                              type: array
                              items:
                                type: string
                                minLength: 1
                            linkedinAccountIds:
                              description: >-
                                Campaign LinkedIn sender pool: up to 50
                                linkedinAccounts ids both you and the campaign
                                owner may use. Omit to preserve existing
                                configuration; [] clears the pool. Legacy step
                                senders remain until a pool is configured.
                              maxItems: 50
                              type: array
                              items:
                                type: string
                                minLength: 1
                            timezone:
                              type: string
                            startsAt:
                              type: number
                            endsAt:
                              type: number
                            sendSchedules:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                    description: Label, e.g. "Mon-Fri 9-18".
                                  timezone:
                                    type: string
                                    description: IANA timezone, e.g. America/Los_Angeles.
                                  startHour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    description: First hour sends may go out (0-23).
                                  endHour:
                                    type: integer
                                    minimum: 1
                                    maximum: 24
                                    description: >-
                                      Hour sends stop (1-24); must be after
                                      startHour.
                                  weekdays:
                                    minItems: 1
                                    type: array
                                    items:
                                      type: integer
                                      minimum: 0
                                      maximum: 6
                                    description: >-
                                      Days sends may go out: 0 = Sunday ... 6 =
                                      Saturday.
                                required:
                                  - name
                                  - timezone
                                  - startHour
                                  - endHour
                                  - weekdays
                                additionalProperties: false
                                description: >-
                                  One send window. A campaign has one to eight;
                                  the first one's timezone is the campaign's.
                            dailySendCap:
                              type: number
                            stepCount:
                              type: number
                            stepModel:
                              type: string
                              enum:
                                - linear
                                - workflow
                              description: >-
                                linear: steps run in order. workflow: steps have
                                keys and paths (next, yesNext, noNext) and may
                                include condition and wait_for_connection. Left
                                out, a workflow stays one and steps with keys,
                                paths or those types make one; nothing turns a
                                workflow back into a list.
                            totalEnrolled:
                              type: number
                            activeCount:
                              type: number
                            pausedCount:
                              type: number
                            finishedCount:
                              type: number
                            repliedCount:
                              type: number
                            failedCount:
                              type: number
                            stoppedCount:
                              type: number
                            launchedAt:
                              type: number
                            ownerName:
                              type: string
                            isOwner:
                              type: boolean
                            createdAt:
                              type: number
                            updatedAt:
                              type: number
                            kind:
                              type: string
                              const: multichannel
                              description: Read with campaigns.get.
                          required:
                            - _id
                            - name
                            - status
                            - stopOnReply
                            - stepCount
                            - totalEnrolled
                            - activeCount
                            - pausedCount
                            - finishedCount
                            - repliedCount
                            - failedCount
                            - stoppedCount
                            - createdAt
                            - updatedAt
                            - kind
                          additionalProperties: {}
                        - type: object
                          properties:
                            _id:
                              type: string
                            kind:
                              type: string
                              const: email_sequence
                              description: Read with email.sequence.get.
                            name:
                              type: string
                            status:
                              type: string
                              enum:
                                - draft
                                - active
                                - archived
                            stepCount:
                              type: number
                            totalEnrolled:
                              type: number
                            createdAt:
                              type: number
                            updatedAt:
                              type: number
                          required:
                            - _id
                            - kind
                            - name
                            - status
                            - stepCount
                            - totalEnrolled
                            - createdAt
                            - updatedAt
                          additionalProperties: {}
                        - type: object
                          properties:
                            _id:
                              type: string
                            kind:
                              type: string
                              const: linkedin_sequence
                              description: >-
                                A legacy LinkedIn-only sequence, opened in the
                                app.
                            name:
                              type: string
                            status:
                              type: string
                              enum:
                                - draft
                                - active
                                - paused
                                - completed
                                - cancelled
                                - archived
                            ownerName:
                              type: string
                            isOwner:
                              type: boolean
                            createdAt:
                              type: number
                            updatedAt:
                              type: number
                          required:
                            - _id
                            - kind
                            - name
                            - status
                            - createdAt
                            - updatedAt
                          additionalProperties: {}
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          anyOf:
                            - type: object
                              properties:
                                _id:
                                  type: string
                                name:
                                  type: string
                                status:
                                  type: string
                                  enum:
                                    - draft
                                    - active
                                    - paused
                                    - completed
                                    - archived
                                  description: Campaign lifecycle status.
                                stopOnReply:
                                  type: boolean
                                emailMailboxAccountIds:
                                  description: >-
                                    Campaign email sender pool: up to 50
                                    emailMailboxAccounts ids both you and the
                                    campaign owner may use. Omit to preserve
                                    existing configuration; [] clears the pool.
                                    A person's sender stays fixed for their
                                    conversation. Launch validates sender
                                    availability.
                                  maxItems: 50
                                  type: array
                                  items:
                                    type: string
                                    minLength: 1
                                linkedinAccountIds:
                                  description: >-
                                    Campaign LinkedIn sender pool: up to 50
                                    linkedinAccounts ids both you and the
                                    campaign owner may use. Omit to preserve
                                    existing configuration; [] clears the pool.
                                    Legacy step senders remain until a pool is
                                    configured.
                                  maxItems: 50
                                  type: array
                                  items:
                                    type: string
                                    minLength: 1
                                timezone:
                                  type: string
                                startsAt:
                                  type: number
                                endsAt:
                                  type: number
                                sendSchedules:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        description: Label, e.g. "Mon-Fri 9-18".
                                      timezone:
                                        type: string
                                        description: IANA timezone, e.g. America/Los_Angeles.
                                      startHour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        description: First hour sends may go out (0-23).
                                      endHour:
                                        type: integer
                                        minimum: 1
                                        maximum: 24
                                        description: >-
                                          Hour sends stop (1-24); must be after
                                          startHour.
                                      weekdays:
                                        minItems: 1
                                        type: array
                                        items:
                                          type: integer
                                          minimum: 0
                                          maximum: 6
                                        description: >-
                                          Days sends may go out: 0 = Sunday ... 6
                                          = Saturday.
                                    required:
                                      - name
                                      - timezone
                                      - startHour
                                      - endHour
                                      - weekdays
                                    additionalProperties: false
                                    description: >-
                                      One send window. A campaign has one to
                                      eight; the first one's timezone is the
                                      campaign's.
                                dailySendCap:
                                  type: number
                                stepCount:
                                  type: number
                                stepModel:
                                  type: string
                                  enum:
                                    - linear
                                    - workflow
                                  description: >-
                                    linear: steps run in order. workflow: steps
                                    have keys and paths (next, yesNext, noNext)
                                    and may include condition and
                                    wait_for_connection. Left out, a workflow
                                    stays one and steps with keys, paths or
                                    those types make one; nothing turns a
                                    workflow back into a list.
                                totalEnrolled:
                                  type: number
                                activeCount:
                                  type: number
                                pausedCount:
                                  type: number
                                finishedCount:
                                  type: number
                                repliedCount:
                                  type: number
                                failedCount:
                                  type: number
                                stoppedCount:
                                  type: number
                                launchedAt:
                                  type: number
                                ownerName:
                                  type: string
                                isOwner:
                                  type: boolean
                                createdAt:
                                  type: number
                                updatedAt:
                                  type: number
                                kind:
                                  type: string
                                  const: multichannel
                                  description: Read with campaigns.get.
                              required:
                                - _id
                                - name
                                - status
                                - stopOnReply
                                - stepCount
                                - totalEnrolled
                                - activeCount
                                - pausedCount
                                - finishedCount
                                - repliedCount
                                - failedCount
                                - stoppedCount
                                - createdAt
                                - updatedAt
                                - kind
                              additionalProperties: {}
                            - type: object
                              properties:
                                _id:
                                  type: string
                                kind:
                                  type: string
                                  const: email_sequence
                                  description: Read with email.sequence.get.
                                name:
                                  type: string
                                status:
                                  type: string
                                  enum:
                                    - draft
                                    - active
                                    - archived
                                stepCount:
                                  type: number
                                totalEnrolled:
                                  type: number
                                createdAt:
                                  type: number
                                updatedAt:
                                  type: number
                              required:
                                - _id
                                - kind
                                - name
                                - status
                                - stepCount
                                - totalEnrolled
                                - createdAt
                                - updatedAt
                              additionalProperties: {}
                            - type: object
                              properties:
                                _id:
                                  type: string
                                kind:
                                  type: string
                                  const: linkedin_sequence
                                  description: >-
                                    A legacy LinkedIn-only sequence, opened in
                                    the app.
                                name:
                                  type: string
                                status:
                                  type: string
                                  enum:
                                    - draft
                                    - active
                                    - paused
                                    - completed
                                    - cancelled
                                    - archived
                                ownerName:
                                  type: string
                                isOwner:
                                  type: boolean
                                createdAt:
                                  type: number
                                updatedAt:
                                  type: number
                              required:
                                - _id
                                - kind
                                - name
                                - status
                                - createdAt
                                - updatedAt
                              additionalProperties: {}
                      references:
                        maxItems: 100
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  const: crm-entry
                                objectName:
                                  type: string
                                entryId:
                                  type: string
                                label:
                                  type: string
                                href:
                                  type: string
                                url:
                                  type: string
                                imageUrl:
                                  type: string
                                objectIcon:
                                  type: string
                              required:
                                - kind
                                - objectName
                                - entryId
                                - label
                                - href
                              additionalProperties: false
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  const: crm-object
                                objectName:
                                  type: string
                                label:
                                  type: string
                                href:
                                  type: string
                                url:
                                  type: string
                                imageUrl:
                                  type: string
                                objectIcon:
                                  type: string
                              required:
                                - kind
                                - objectName
                                - label
                                - href
                              additionalProperties: false
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  const: campaign
                                sequenceId:
                                  type: string
                                label:
                                  type: string
                                href:
                                  type: string
                                url:
                                  type: string
                                imageUrl:
                                  type: string
                                objectIcon:
                                  type: string
                              required:
                                - kind
                                - sequenceId
                                - label
                                - href
                              additionalProperties: false
                      referenceCoverage:
                        type: object
                        properties:
                          returned:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          available:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          truncated:
                            type: boolean
                        required:
                          - returned
                          - available
                          - truncated
                        additionalProperties: false
                    required:
                      - data
                      - references
                      - referenceCoverage
                    additionalProperties: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - DenchApiKey: []
        - AgentSession: []
components:
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Operation or resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - code
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: string
            details: {}
  securitySchemes:
    DenchApiKey:
      type: http
      scheme: bearer
      bearerFormat: DENCH_API_KEY
      description: >-
        Workspace-scoped Dench API key from workspace settings. This is the same
        key used by DENCH_API_KEY in sandboxes.
    AgentSession:
      type: http
      scheme: bearer
      bearerFormat: dch_agent_*
      description: >-
        Agent session token created by `dench signin`. Gateway-backed routes
        exchange this token for the workspace gateway key.

````

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