cliDeterministic

List campaigns

pipeline list-campaigns

List all campaigns in your workspace. Filter by status (draft, active, paused, completed) and paginate results.

Parameters

workspaceId

string

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

status

string

No description.

draft | active | paused | completed

page

number

No description.

limit

number

No description.

Example

CLI commandbash

pipeline list-campaigns

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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"
  ]
}

Exit codes

1: Invalid input or local configuration.
2: The API or tool returned an error.
3: Authentication failed.
4: A network request failed.