Get Campaign by ID

v1.0.0

Retrieves detailed information about a specific campaign by its ID. Returns complete campaign configuration including all settings, schedule, and metadata.

Features:

Verifies campaign ownership
Returns 404 if campaign not found
Optionally includes tags when include_tags=true

Input

{
  "type": "object",
  "properties": {
    "campaign_id": {
      "type": "integer"
    },
    "include_tags": {
      "type": "boolean"
    }
  },
  "required": [
    "campaign_id"
  ],
  "additionalProperties": false
}

Output

{
  "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"
    }
  }
}