List Campaigns

List all campaigns for the authenticated user.

Args: current_user: Authenticated user information service: Campaign service instance status_filter: Optional status filter search: Optional search term for campaign name page: Page number (1-indexed) page_size: Items per page (max 100)

Returns: Paginated list of campaigns

GET /api/v1/campaigns

List Campaigns

cURL

curl --request GET \
  --url https://api.example.com/api/v1/campaigns/ \
  --header 'Authorization: Bearer <token>'

200

{
  "campaigns": [
    {
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<string>",
      "status": "draft",
      "launch_type": "immediate",
      "daily_limit": 123,
      "sending_window_start": "<string>",
      "sending_window_end": "<string>",
      "min_interval_seconds": 123,
      "timezone": "<string>",
      "steps_config": [
        {
          "step": 2,
          "delay_days": 1,
          "channel": "email",
          "variants": [
            {
              "label": "<string>",
              "weight": 50,
              "type": "TEMPLATE",
              "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sender_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "ai_personalization_enabled": true,
          "track_clicks": false,
          "action_type": "connection_request",
          "message_template": "<string>"
        }
      ],
      "send_days": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "alias_ids": [
        "<string>"
      ],
      "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "total_leads": 123,
      "processed_leads": 0,
      "launch_job_id": "<string>",
      "launch_requested_at": "2023-11-07T05:31:56Z",
      "launch_error": "<string>",
      "system_prompt": "<string>",
      "unreviewed_launch_policy": "launch_default",
      "paused_reason": "<string>",
      "playground_discovery_dismissed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status · enum<string> | null

Campaign status values.

Available options: draft, launching, scheduled, active, draining, paused, completed, failed

search · string | null

Search by campaign name

page · integer · default: 1

Page number

Required range: x >= 1

page_size · integer · default: 20

Items per page

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response

Response model for campaign list.

campaigns · CampaignResponse · object[] · required

List of campaigns

Show child attributes

total · integer · required

Total number of campaigns

page · integer · required

Current page number

page_size · integer · required

Items per page