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
  • 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
    • 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
Lead
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
workspace_id
string 
required
Workspace ID
Default:
Example:
65f3c92d3dbe5dbb35374a9a
email
string <email>
required
Default:
Example:
lead@example.com
campaign_id
string 
optional
Campaign ID
Default:
Example:
66b447598f6dd99f7f7b5c0a
skip
integer 
optional
>= 0
Default:
Example:
limit
integer 
optional
>= 1<= 100
Default:
Example:
10
Header Params
x-api-key
string 
required
Your PlusVibe.ai account's API Key
Default:
Example:
your-api-key

Responses

🟢200OK
application/json
Successful operation
Body
id
string 
optional
Lead ID
Example:
65f3c92d3dbe5dbb35374a9a
timestamp_created
string <date-time>
optional
The date and time when the lead was created.
Example:
2024-08-14T08:45:30Z
campaign
string 
optional
The ID of the campaign that the lead is associated to.
Example:
65f3c92d3dbe5dbb35374a9b
status
string 
optional
Current status of the lead within the campaign.
Example:
CONTACTED
contact
string <email>
optional
Email address of the lead.
Example:
lead@example.com
email_opened
boolean 
optional
Indicates whether the lead has opened the email sent to them.
Example:
true
email_replied
boolean 
optional
Indicates whether the lead has replied to the email.
Example:
false
lead_data
object 
optional
organization_id
string 
optional
The ID of the organization to which the lead belongs.
Example:
65f3c92d3dbe5dbb35374a9a
current_step
integer <int32>
optional
The current step in the campaign sequence.
Example:
3
next_email_time
string <date-time>
optional
The scheduled time for the next email to be sent to the lead.
Example:
2024-08-13T14:30:00Z
email_account_id
string <email>
optional
The sender email account that has contacted the lead.
Example:
sender@account.com
label
string 
optional
A label or tag associated with the lead.
Example:
Interested
parent_camp_id
string 
optional
The ID of the parent campaign if the lead is part of a sequence.
Example:
65f3c92d3dbe5dbb35374a9a
parent_lead_id
string 
optional
The ID of the parent lead if the current lead is a follow-up.
Example:
66b447598f6dd99f7f7b5c0a
is_email_verified
string 
optional
Indicates if the lead's email has been verified (Possible values: NOT_CHECKED, VALID, INVALID, RISKY).
Example:
VALID
last_sent_at
string <date-time>
optional
The timestamp of when the last email was sent to the lead.
Example:
2024-08-12T10:00:00Z
email
string <email>
optional
The email address of the lead.
Example:
lead@example.com
first_name
string 
optional
The first name of the lead.
Example:
John
last_name
string 
optional
The last name of the lead.
Example:
Doe
address_line
string 
optional
The street address of the lead.
Example:
123 Main St
city
string 
optional
The city where the lead is located.
Example:
New York
country
string 
optional
The country where the lead is located.
Example:
United States
country_code
string 
optional
The ISO 3166-1 alpha-2 country code.
Example:
US
phone_number
string 
optional
The phone number of the lead.
Example:
+1-555-555-5555
company_name
string 
optional
The name of the company where the lead works.
Example:
Acme Corp
company_website
string 
optional
The website of the lead's company.
Example:
https://www.plusvibe.ai
linkedin_person_url
string 
optional
The LinkedIn profile URL of the lead.
Example:
https://www.linkedin.com/in/johndoe
linkedin_company_url
string 
optional
The LinkedIn page URL of the lead's company.
Example:
https://www.linkedin.com/company/plusvibeai
campaign_name
string 
optional
The name of the campaign associated with this lead.
Example:
Summer Promotion Campaign
🟠400Bad Request
🔴500Server Error
Modified at 2025-05-24 05:40:10
Previous
Add leads to a subsequence campaign
Next
Delete leads from a campaign
Built with