List all campaigns

GET

https://api.plusvibe.ai/api/v1/campaign/list-all

Campaign

Retrieve a list of campaigns for a specific workspace with optional filtering capabilities. Results are sorted by creation date with the newest campaigns first.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.plusvibe.ai/api/v1/campaign/list-all?workspace_id&campaign_id&status&campaign_type&skip&limit' \
--header 'X-API-Key;'

Response Example

200 - Success

[
  {
    "id": "67b5aeac332004b217cfa997",
    "camp_name": "Product Demo Campaign",
    "parent_camp_id": "",
    "campaign_type": "parent",
    "organization_id": "6509f7691205283f2a79f98b",
    "workspace_id": "6509f7691205283f2a79f98c",
    "status": "COMPLETED",
    "created_at": "2025-02-19T10:13:00.788Z",
    "modified_at": "2025-03-03T17:39:00.223Z",
    "tags": [
      "66facee0d4198b6a2e461ce1"
    ],
    "template_id": "",
    "email_accounts": [
      "6746f785a5ecee09c96240e6",
      "67a444ee50b2a05f84141207"
    ],
    "daily_limit": 600,
    "interval_limit_in_min": 1,
    "send_priority": 0.25,
    "send_as_txt": 1,
    "is_emailopened_tracking": 0,
    "is_unsubscribed_link": 0,
    "exclude_ooo": 0,
    "is_acc_based_sending": 0,
    "send_risky_email": 0,
    "unsub_blocklist": 0,
    "other_email_acc": 1,
    "is_esp_match": 0,
    "stop_on_lead_replied": 1,
    "is_pause_on_bouncerate": 0,
    "bounce_rate_limit": 5,
    "is_paused_at_bounced": 0,
    "last_paused_at_bounced": "",
    "schedule": {
      "days": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday"
      ],
      "from_time": "10:00",
      "to_time": "17:00",
      "tz": "America/New_York"
    },
    "first_wait_time": 3,
    "camp_st_date": "",
    "camp_end_date": "",
    "events": [
      ""
    ],
    "last_lead_sent": "2025-03-03T17:38:44.179Z",
    "sequences": [
      {
        "step": 1,
        "wait_time": 2,
        "variations": [
          {
            "variation": "A",
            "subject": "Your product needs evaluation",
            "body": "<div>Hello {{first_name}},</div><div> </div><div>I noticed your company is using similar solutions and wanted to reach out.</div><div> </div><div>Our platform offers competitive features at a better price point.</div><div> </div><div>Would you be interested in a demo?</div><div> </div><div>Best regards,</div><div>{{sender_first_name}}</div>"
          }
        ]
      }
    ],
    "sequence_steps": 3,
    "camp_emails": [
      ""
    ],
    "lead_count": 432,
    "completed_lead_count": 432,
    "lead_contacted_count": 286,
    "sent_count": 841,
    "opened_count": 0,
    "unique_opened_count": 0,
    "replied_count": 3,
    "bounced_count": 8,
    "unsubscribed_count": 0,
    "positive_reply_count": 2,
    "negative_reply_count": 0,
    "neutral_reply_count": 0,
    "email_sent_today": 0,
    "opportunity_val": 0,
    "open_rate": 0,
    "replied_rate": 1,
    "custom_fields": [
      ""
    ]
  }
]

Request

Query Params

workspace_id

string

required

ID of the workspace to fetch campaigns from

Default:

Example:

6509f7691205283f2a87f98c

campaign_id

string

optional

Filter by specific campaign ID

Default:

Example:

status

enum<string>

optional

Filter by campaign status

Allowed values:

ACTIVEPAUSEDCOMPLETEDARCHIVED

Default:

Example:

ACTIVE

campaign_type

enum<string>

optional

Filter by campaign type: 'all' (default), 'parent' (regular campaigns), or 'subseq' (only subsequence campaigns)

Allowed values:

allparentsubseq

Default:

all

Example:

all

skip

integer

optional

Number of records to skip for pagination

>= 0

Default:

Example:

limit

integer

optional

Maximum number of records to return

>= 1<= 100

Default:

Example:

Header Params

X-API-Key

string

optional

Your PlusVibe.ai account's API Key

Default:

Example:

your-api-key

Responses

🟢200OK

application/json

Successfully retrieved campaigns

Body

array of:

string

optional

camp_name

string

optional

parent_camp_id

string

optional

campaign_type

string

optional

organization_id

string

optional

workspace_id

string

optional

status

string

optional

created_at

string

optional

modified_at

string

optional