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

# List Campaigns

> List workspace campaigns, status, and outreach counts.

Requires `campaigns:read`. Filter with `status=all|active|paused|draft|finished`.

Pagination uses `page` (default 1, maximum 100) and `limit` (default 20, maximum 100). The response contains `campaigns` and `pagination`. MCP's cursor pagination is a separate interface.

```bash theme={null}
curl 'https://api.sendpilot.ai/v1/campaigns?status=active&page=1&limit=20' \
  -H "X-API-Key: $SENDPILOT_API_KEY"
```


## OpenAPI

````yaml GET /v1/campaigns
openapi: 3.0.0
info:
  title: SendPilot External API
  description: >

    # SendPilot External API v1


    Public API for integrating with SendPilot programmatically.


    ## Authentication


    Requests authenticate with a workspace API key in the `X-API-Key` header:


    ```

    X-API-Key: sp_live_your_api_key_here

    ```


    `Authorization: Bearer sp_live_...` (or `sp_test_...`) is also accepted.
    Prefer one header; `X-API-Key` takes precedence. Clerk OAuth tokens for MCP
    connection URLs are not public REST API keys.


    A key only reaches what its scopes and creator's current workspace
    permissions allow. Each operation lists the scopes it needs in
    `x-sp-scopes`. Use `GET /v1/me` to inspect the effective permissions and
    subscription state.


    ## Rate Limits


    - **Per API Key**: 300 requests/minute

    - **Per Workspace**: 50,000 requests/day


    Responses that reach the rate limiter include these headers; early
    authentication failures may not:

    - `X-RateLimit-Limit`: Max requests per minute

    - `X-RateLimit-Remaining`: Remaining requests in current window

    - `X-RateLimit-Reset`: Epoch timestamp when limit resets


    ## LinkedIn Sender Limits


    When using messaging endpoints, these headers show account limits:

    - `X-LinkedIn-Messages-Remaining`: Messages left today

    - `X-LinkedIn-Connections-Remaining`: Connection requests left today

    - `X-LinkedIn-Quota-Reset-At`: When daily limits reset


    ## Retries


    Send an `Idempotency-Key` header on POST and PATCH requests. A retry with
    the same key within 24 hours returns the first result (with
    `Idempotent-Replayed: true`) instead of acting twice. The same key with a
    different request answers 422 `IDEMPOTENCY_KEY_REUSED`; a retry while the
    first request still runs answers 409 `IDEMPOTENCY_IN_PROGRESS`.


    Once execution is attempted, its response (including errors) is retained. If
    a process stops or result storage fails after the attempt, the durable
    record blocks another execution for the replay window and returns 409
    `IDEMPOTENCY_IN_PROGRESS` or `IDEMPOTENCY_REPLAY_UNAVAILABLE`. Check the
    operation's status before using a new key: an uncertain outcome may already
    have acted. Requests refused before execution is claimed, such as
    authentication or rate-limit refusals, can be retried with the same key.


    ## Webhooks


    Configure webhooks in the SendPilot app to receive real-time events:

    - `lead.tag.updated`

    - `lead.updated`

    - `message.sent`

    - `reply.received`

    - `connection_request.sent`

    - `connection_request.accepted`

    - `campaign.started`

    - `campaign.paused`

    - `campaign.resumed`

    - `campaign.finished`


    ## Error Codes


    Errors return a JSON body. Use the machine-readable `code` when supplied;
    validation messages can be arrays, and some legacy errors omit `code`. A
    typical error is:

    ```json

    {
      "statusCode": 400,
      "error": "Bad Request",
      "code": "SPECIFIC_ERROR_CODE",
      "message": "Human-readable description"
    }

    ```
  version: '1.0'
  contact:
    name: SendPilot Support
    url: https://sendpilot.ai
    email: support@sendpilot.ai
servers:
  - url: https://api.sendpilot.ai
security: []
tags: []
paths:
  /v1/campaigns:
    get:
      tags:
        - External API - Campaigns
      summary: List campaigns
      description: Retrieves all campaigns for the workspace with optional status filtering
      operationId: campaigns.list
      parameters:
        - name: status
          required: false
          in: query
          description: Filter by campaign status
          schema:
            default: all
            enum:
              - all
              - active
              - paused
              - draft
              - finished
            type: string
        - name: page
          required: false
          in: query
          description: Page number for pagination (1-indexed)
          schema:
            minimum: 1
            maximum: 100
            default: 1
            type: number
        - name: limit
          required: false
          in: query
          description: Maximum number of items to return
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: number
      responses:
        '200':
          description: List of campaigns
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignListResponseDto'
        '401':
          description: Invalid or missing API key
        '429':
          description: Rate limit exceeded
      security:
        - api-key: []
components:
  schemas:
    CampaignListResponseDto:
      type: object
      properties:
        campaigns:
          description: List of campaigns
          type: array
          items:
            $ref: '#/components/schemas/CampaignSummaryDto'
        pagination:
          description: Pagination info
          allOf:
            - $ref: '#/components/schemas/PaginationDto'
      required:
        - campaigns
        - pagination
    CampaignSummaryDto:
      type: object
      properties:
        id:
          type: string
          description: Campaign ID
          example: clxyz123...
        name:
          type: string
          description: Campaign name
          example: Q1 Outreach
        status:
          type: string
          description: Campaign status
          example: started
          enum:
            - not_started
            - started
            - paused
            - failed
            - finished
            - scheduling
            - draft
            - unknown
        totalLeads:
          type: number
          description: Total leads in campaign
          example: 500
        connectionsSent:
          type: number
          description: Connections sent
          example: 200
        connectionsAccepted:
          type: number
          description: Connections accepted
          example: 80
        messagesSent:
          type: number
          description: Messages sent
          example: 150
        repliesReceived:
          type: number
          description: Replies received
          example: 25
        createdAt:
          format: date-time
          type: string
          description: When the campaign was created
        updatedAt:
          format: date-time
          type: string
          description: When the campaign was last updated
      required:
        - id
        - name
        - status
        - totalLeads
        - createdAt
    PaginationDto:
      type: object
      properties:
        page:
          type: number
          description: Current page number
          example: 1
        limit:
          type: number
          description: Items per page
          example: 20
        total:
          type: number
          description: Total number of items
          example: 150
        totalPages:
          type: number
          description: Total number of pages
          example: 8
      required:
        - page
        - limit
        - total
        - totalPages
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for authentication (prefix: sp_live_ or sp_test_)'

````

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