Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Get campaign

GET /api/mcp/campaigns/{campaignId}

Get detailed information about a specific campaign including settings, prospect count, and current status.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

campaignIdrequired

string

The unique identifier of the campaign

Example

REST requestbash

curl -X GET "https://app.pipeline.help/api/mcp/campaigns/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "draft",
            "active",
            "paused",
            "completed",
            "scheduled",
            "preparing",
            "preparing_review"
          ]
        },
        "total_prospects": {
          "type": "number"
        },
        "prospects_completed": {
          "type": "number"
        },
        "prospects_active": {
          "type": "number"
        },
        "auto_generated": {
          "type": "boolean"
        },
        "source_tracker_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "brief_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "created_by": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "workflow_definition": {
          "type": "object",
          "properties": {
            "nodes": {
              "type": "array",
              "items": {
                "type": "object"
              }
            },
            "edges": {
              "type": "array",
              "items": {
                "type": "object"
              }
            }
          },
          "required": [
            "nodes",
            "edges"
          ]
        },
        "assigned_accounts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "started_at": {
          "type": "string"
        },
        "completed_at": {
          "type": "string"
        },
        "archived_at": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "workspace_id",
        "name",
        "status"
      ]
    }
  },
  "required": [
    "data"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.