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

# List campaigns

> **List all campaigns in your workspace**

Retrieve a paginated list of campaigns with filtering and sorting options.

## Filtering Options

- **status**: Filter by campaign status (DRAFT, ACTIVE, PAUSED, COMPLETED, FAILED)
- **search**: Search campaigns by name (case-insensitive partial match)
- **days**: Filter campaigns created in the last N days

## Sorting Options

- **sort_by**: Field to sort by (name, status, created_at, launched_at, sent_count, reply_count)
- **sort_order**: Sort direction (asc, desc)

## Pagination

- **page**: Page number (1-based)
- **limit**: Items per page (1-100, default 20)

## Example Usage

```python
import requests

response = requests.get(
    "https://api.coldsend.io/api/public/v1/campaigns?status=ACTIVE&sort_by=created_at&sort_order=desc",
    headers={"X-API-Key": "your-api-key"}
)

print(response.json())
```



## OpenAPI

````yaml /public_openapi.json get /api/public/v1/campaigns
openapi: 3.0.3
info:
  title: ColdSend Public API
  description: >-
    Programmatic access to ColdSend for managing cold email campaigns and sender
    accounts.
  version: 1.0.0
  contact:
    name: ColdSend Support
    email: support@coldsend.pro
    url: https://coldsend.pro
servers:
  - url: https://api.coldsend.pro
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/public/v1/campaigns:
    get:
      tags:
        - Campaigns
      summary: List campaigns
      description: >-
        **List all campaigns in your workspace**


        Retrieve a paginated list of campaigns with filtering and sorting
        options.


        ## Filtering Options


        - **status**: Filter by campaign status (DRAFT, ACTIVE, PAUSED,
        COMPLETED, FAILED)

        - **search**: Search campaigns by name (case-insensitive partial match)

        - **days**: Filter campaigns created in the last N days


        ## Sorting Options


        - **sort_by**: Field to sort by (name, status, created_at, launched_at,
        sent_count, reply_count)

        - **sort_order**: Sort direction (asc, desc)


        ## Pagination


        - **page**: Page number (1-based)

        - **limit**: Items per page (1-100, default 20)


        ## Example Usage


        ```python

        import requests


        response = requests.get(
            "https://api.coldsend.io/api/public/v1/campaigns?status=ACTIVE&sort_by=created_at&sort_order=desc",
            headers={"X-API-Key": "your-api-key"}
        )


        print(response.json())

        ```
      operationId: list_campaigns_api_public_v1_campaigns_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number
            default: 1
            title: Page
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Items per page
            default: 20
            title: Limit
          description: Items per page
        - name: status_filter
          in: query
          required: false
          schema:
            type: string
            nullable: true
            title: Status Filter
            description: Filter by status
          description: Filter by status
        - name: search
          in: query
          required: false
          schema:
            type: string
            nullable: true
            title: Search
            description: Search by name
          description: Search by name
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
            nullable: true
            title: Sort By
            description: Sort field
          description: Sort field
        - name: sort_order
          in: query
          required: false
          schema:
            type: string
            nullable: true
            title: Sort Order
            description: Sort order (asc/desc)
          description: Sort order (asc/desc)
        - name: days
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            nullable: true
            title: Days
            description: Filter by days since creation
          description: Filter by days since creation
      responses:
        '200':
          description: Campaigns retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignListResponse'
        '401':
          description: Missing or invalid API key
        '403':
          description: Insufficient permissions - requires 'campaigns:read' scope
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CampaignListResponse:
      properties:
        success:
          type: boolean
          title: Success
        message:
          type: string
          title: Message
        campaigns:
          items:
            $ref: '#/components/schemas/CampaignListItem'
          type: array
          title: Campaigns
          description: List of campaigns
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
          description: Pagination information
      type: object
      required:
        - success
        - message
        - campaigns
        - pagination
      title: CampaignListResponse
      description: Response for listing campaigns.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CampaignListItem:
      properties:
        campaign_id:
          type: string
          format: uuid
          title: Campaign Id
          description: Campaign ID
        name:
          type: string
          title: Name
          description: Campaign name
        status:
          type: string
          title: Status
          description: Campaign status
        current_step:
          type: integer
          title: Current Step
          description: Current creation step
        enable_tracking:
          type: boolean
          title: Enable Tracking
          description: Whether open tracking was enabled for this campaign
          default: false
        enable_click_tracking:
          type: boolean
          title: Enable Click Tracking
          description: Whether click-through-rate tracking is enabled for this campaign
          default: false
        total_leads:
          type: integer
          title: Total Leads
          description: Total leads
          default: 0
        sent_count:
          type: integer
          title: Sent Count
          description: Emails sent
          default: 0
        reply_count:
          type: integer
          title: Reply Count
          description: Replies received
          default: 0
        open_count:
          type: integer
          title: Open Count
          description: Emails opened
          default: 0
        bounce_count:
          type: integer
          title: Bounce Count
          description: Emails bounced
          default: 0
        unsubscribe_count:
          type: integer
          title: Unsubscribe Count
          description: Unsubscribes
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
        launched_at:
          type: string
          format: date-time
          nullable: true
          title: Launched At
          description: Launch timestamp
      type: object
      required:
        - campaign_id
        - name
        - status
        - current_step
        - created_at
        - launched_at
      title: CampaignListItem
      description: Campaign list item schema.
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        limit:
          type: integer
          title: Limit
        total:
          type: integer
          title: Total
        pages:
          type: integer
          title: Pages
        has_next:
          type: boolean
          title: Has Next
        has_prev:
          type: boolean
          title: Has Prev
      type: object
      required:
        - page
        - limit
        - total
        - pages
        - has_next
        - has_prev
      title: PaginationMeta
      description: Pagination metadata schema.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key with format cs_live_xxx

````