PlusVibe.ai
  1. Lead
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. Lead

Get or search for lead

GET
https://api.plusvibe.ai/api/v1/lead/get
This endpoint can also be used to search for a lead - if campaign_id is left blank, all leads matching email will be returned.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.plusvibe.ai/api/v1/lead/get?workspace_id&email' \
--header 'x-api-key;'
Response Response Example
200 - Example 1
{
    "id": "65f3c92d3dbe5dbb35374a9a",
    "timestamp_created": "2024-08-14T08:45:30Z",
    "campaign": "65f3c92d3dbe5dbb35374a9b",
    "status": "CONTACTED",
    "contact": "lead@example.com",
    "email_opened": true,
    "email_replied": false,
    "lead_data": {
        "organization_id": "65f3c92d3dbe5dbb35374a9a",
        "current_step": 3,
        "next_email_time": "2024-08-13T14:30:00Z",
        "email_account_id": "sender@account.com",
        "label": "Interested",
        "parent_camp_id": "65f3c92d3dbe5dbb35374a9a",
        "parent_lead_id": "66b447598f6dd99f7f7b5c0a",
        "is_email_verified": "VALID",
        "last_sent_at": "2024-08-12T10:00:00Z",
        "email": "lead@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "address_line": "123 Main St",
        "city": "New York",
        "country": "United States",
        "country_code": "US",
        "phone_number": "+1-555-555-5555",
        "company_name": "Acme Corp",
        "company_website": "https://www.plusvibe.ai",
        "linkedin_person_url": "https://www.linkedin.com/in/johndoe",
        "linkedin_company_url": "https://www.linkedin.com/company/plusvibeai"
    },
    "campaign_name": "Summer Promotion Campaign"
}

Request

Query Params

Header Params

Responses

🟢200OK
application/json
Successful operation
Body

🟠400Bad Request
🔴500Server Error
Modified at 2025-07-28 13:01:08
Previous
Add leads to a subsequence campaign
Next
Delete leads from a campaign
Built with