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

# List campaigns by status

> GET /api/v1/campaigns/by-status?status=live|paused|terminated

Required query param:
  status=live|paused|terminated

Optional query params:
  period=today|this_week|this_month|this_year
  start_date=YYYY-MM-DD
  end_date=YYYY-MM-DD



## OpenAPI

````yaml /openapi/commercial.yaml get /api/v1/campaigns/by-status
openapi: 3.0.3
info:
  title: Commercial Service API
  version: 1.0.0
  description: |2-

        **Commercial Service API** - Lead management and campaign workflow system.

        ## Versioning
        The API uses URL path versioning (e.g., `/api/v1/`, `/api/v2/`).
        Current version: **v1**
        
servers:
  - url: https://api.capedigital.co.ke/commercial
    description: Production
  - url: http://localhost:8000
    description: Local
security: []
paths:
  /api/v1/campaigns/by-status:
    get:
      tags:
        - Campaigns
      summary: List campaigns by status
      description: |-
        GET /api/v1/campaigns/by-status?status=live|paused|terminated

        Required query param:
          status=live|paused|terminated

        Optional query params:
          period=today|this_week|this_month|this_year
          start_date=YYYY-MM-DD
          end_date=YYYY-MM-DD
      operationId: campaigns_by_status
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
              examples:
                CampaignResponse:
                  value:
                    id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    reference: CP-2024-001
                    start_date: '2024-02-01'
                    end_date: '2024-02-28'
                    status: Campaign In Progress
                    node: on_air
                    company_name: ABC Corporation
                    products:
                      - id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        name: TV Spot 30s
                    created_at: '2024-01-15T08:00:00Z'
                    updated_at: '2024-01-15T08:00:00Z'
                  summary: Campaign response
          description: ''
      security:
        - bearerAuth: []
components:
  schemas:
    Campaign:
      type: object
      description: Campaign Serializer
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        reference:
          type: string
          nullable: true
          description: Generated reference string
          maxLength: 30
        name:
          type: string
          description: Campaign name (captured at client commitment)
          maxLength: 255
        start_date:
          type: string
          format: date
          description: Campaign start date
        end_date:
          type: string
          format: date
          description: Campaign end date
        status:
          type: string
          description: Lead status
          maxLength: 50
        node:
          type: string
          description: Workflow Node
          maxLength: 50
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - created_at
        - end_date
        - id
        - node
        - start_date
        - status
        - updated_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Enter your JWT token in the format: Bearer <token>'

````