Get All Campaigns

v1.0.0

Retrieves all email campaigns for the authenticated user with comprehensive campaign data including status, schedule settings, tracking configuration, AI matching preferences, and sending limits.

Key Features:

Returns campaigns ordered by ID descending (newest first)
Supports optional client_id filtering for agency/white-label accounts
When include_tags=true, returns campaign tags with IDs, names, and colors
Returns direct array of campaign objects (not wrapped)

Input

{
  "type": "object",
  "properties": {
    "client_id": {
      "type": "integer"
    },
    "include_tags": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "client_id": {
        "type": "integer"
      },
      "created_at": {
        "type": "string",
        "format": "date-time",
        "description": "ISO 8601 timestamp when campaign was created"
      },
      "enable_ai_esp_matching": {
        "type": "boolean"
      },
      "follow_up_percentage": {
        "type": "integer"
      },
      "id": {
        "type": "integer",
        "description": "Unique campaign identifier"
      },
      "max_leads_per_day": {
        "type": "integer",
        "description": "Maximum leads per day"
      },
      "min_time_btwn_emails": {
        "type": "integer",
        "description": "Minimum minutes between emails"
      },
      "name": {
        "type": "string",
        "description": "Campaign name"
      },
      "scheduler_cron_value": {
        "type": "object",
        "properties": {
          "days": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          },
          "endHour": {
            "type": "string"
          },
          "startHour": {
            "type": "string"
          },
          "tz": {
            "type": "string"
          }
        }
      },
      "send_as_plain_text": {
        "type": "boolean"
      },
      "status": {
        "type": "string",
        "description": "Current campaign status",
        "enum": [
          "ACTIVE",
          "PAUSED",
          "STOPPED",
          "ARCHIVED",
          "DRAFTED"
        ]
      },
      "stop_lead_settings": {
        "type": "string",
        "enum": [
          "REPLY_TO_AN_EMAIL",
          "OPENED_EMAIL",
          "CLICKED_LINK",
          "NEVER"
        ]
      },
      "tags": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "tag_color": {
              "type": "string"
            },
            "tag_id": {
              "type": "integer"
            },
            "tag_name": {
              "type": "string"
            }
          }
        }
      },
      "track_settings": {
        "type": "array",
        "description": "Tracking configuration",
        "items": {
          "type": "string",
          "enum": [
            "DONT_EMAIL_OPEN",
            "DONT_LINK_CLICK"
          ]
        }
      },
      "updated_at": {
        "type": "string",
        "format": "date-time",
        "description": "ISO 8601 timestamp of last modification"
      },
      "user_id": {
        "type": "integer",
        "description": "ID of the user who owns this campaign"
      }
    }
  }
}