PlusVibe.ai
  1. Campaign
PlusVibe.ai
  • PlusVibe.ai API Documentation
  • Workspace
    • Get workspaces
      GET
    • Add a new workspace
      POST
  • Campaign
    • Create a new campaign
      POST
    • Create a new subsequence
      POST
    • List campaigns (deprecated)
      GET
    • List all campaigns
      GET
    • Get campaign name
      GET
    • Get campaign status
      GET
    • Get campaign email accounts
      GET
    • Get campaign emails
      GET
    • Set campaign name
      POST
    • Set campaign Schedules
      POST
    • Activate campaign
      POST
    • Pause campaign
      POST
    • Update Campaign
      PATCH
  • Lead
    • Add leads to a campaign
      POST
    • Add leads to a subsequence campaign
      POST
    • Get or search for lead
      GET
    • Delete leads from a campaign
      POST
    • Lead Variable/Label Update or Add
      POST
    • Fetch workspace leads
      GET
    • Update the status of a lead
      POST
  • Email Account
    • List all email accounts in the workspace
      GET
    • Get email account status
      GET
    • Check account vitals
      POST
    • Enable Email account warmup
      POST
    • Pause Email account warmup
      POST
    • Delete Email account
      POST
    • Get Warmup Stats (Individual Account)
      GET
    • Get Warmup Stats (Workspace-Level)
      GET
    • Bulk Add SMTP Accounts
      POST
  • Analytics
    • Get campaign summary
    • Get campaign count (deprecated)
    • Get campaign stats
    • Get all campaigns statistics
  • Unibox
    • Get emails
    • Get count of unread emails
    • Reply to an email
    • Forward an existing email
    • Mark email read
  • Blocklist
    • Get entries in the blocklist
    • Adds entries to the blocklist
    • Delete entries in the blocklist
  • Webhook
    • PlusVibe Webhook Overview
    • Sample Payload - FIRST_EMAIL_REPLIES, ALL_EMAIL_REPLIES, ALL_POSITIVE_REPLIES
    • Sample Payload - LEAD_MARKED_AS_INTERESTED
    • Sample Payload - EMAIL_SENT
    • Sample Payload - BOUNCED_EMAIL
    • Add a new webhook
    • List webhooks
    • Delete webhook(s)
  • Tag
    • List Tags
  • For Email Infra Provider Partner
    • List workspaces
    • Initiate Google OAuth login flow
    • Initiate Microsoft OAuth login flow
    • Bulk Add SMTP Accounts (via Username and Password)
  1. Campaign

List all campaigns

GET
https://api.plusvibe.ai/api/v1/campaign/list-all
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 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 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

Header Params

Responses

🟢200OK
application/json
Successfully retrieved campaigns
Body

🟠400Bad Request
Modified at 2025-05-24 06:40:48
Previous
List campaigns (deprecated)
Next
Get campaign name
Built with