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

Fetch workspace leads

GET
https://api.plusvibe.ai/api/v1/lead/workspace-leads
Lead
Retrieve a list of leads based on specified filters like status, campaign, and more.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.plusvibe.ai/api/v1/lead/workspace-leads?workspace_id'
Response Response Example
{
    "_id": "66eee7889475e631ac0d156c",
    "organization_id": "65099a0dd96fae8ab61130bf",
    "campaign_id": "66eee42f9475e631ac0d1568",
    "workspace_id": "65099a0dd96fae8ab61130c0",
    "is_completed": 1,
    "current_step": 1,
    "email_account_id": "string",
    "created_at": "2024-09-14T06:29:55.185Z",
    "modified_at": "2024-09-14T06:29:55.185Z",
    "status": "SKIPPED",
    "label": "string",
    "email_acc_name": "string",
    "camp_name": "Campaign Name Example",
    "sent_step": 0,
    "replied_count": 0,
    "opened_count": 0,
    "last_sent_at": "2019-08-24T14:15:22Z",
    "is_mx": -1,
    "mx": "string",
    "email": "lead@abc.com",
    "first_name": "string",
    "last_name": "string",
    "address_line": "200 Park Ave",
    "city": "New York",
    "state": "string",
    "country": "string",
    "country_code": "string",
    "phone_number": "(021) 765-3710",
    "job_title": "string",
    "department": "string",
    "company_name": "ACME Company",
    "company_website": "https://company.com",
    "industry": "string",
    "linkedin_person_url": "string",
    "linkedin_company_url": "string",
    "total_steps": 4
}

Request

Query Params
workspace_id
string 
required
Unique identifier of the workspace.
Default:
Example:
65099a0dd96fae8ab61130c0
campaign_id
string 
optional
Unique identifier of the campaign.
Default:
Example:
66eee42f9475e631ac0d1568
status
enum<string> 
optional
Filter by lead status.
Allowed values:
SKIPPEDCOMPLETEDPENDINGNOT_CONTACTEDCONTACTEDBOUNCEDREPLIEDUNSUBSCRIBEDRESCHEDULED
Default:
Example:
SKIPPED
label
enum<string> 
optional
Filter by label associated with the lead. (Uppercase with underscore)
Allowed values:
INTERESTEDNOT_INTERESTEDMY_LABEL_NAME
Default:
Example:
INTERESTED
email
string 
optional
Filter by email address.
Default:
Example:
lead@abc.com
first_name
string 
optional
Filter by first name.
Default:
Example:
last_name
string 
optional
Filter by last name.
Default:
Example:
page
integer 
optional
The page number for paginated results.
Default:
Example:
1
limit
integer 
optional
The number of results per page.
Default:
Example:
10
sort
string 
optional
Field to sort results by.
Default:
Example:
_id
direction
enum<string> 
optional
Sort direction (ascending or descending).
Allowed values:
ascdesc
Default:
Example:
asc
Header Params
x-api-key
string 
optional
Your PlusVibe.ai account's API Key
Default:
Example:
your-api-key

Responses

🟢200OK
application/json
A list of leads matching the filters.
Body
_id
string 
optional
Unique identifier for the lead.
Example:
66eee7889475e631ac0d156c
organization_id
string 
optional
Unique identifier for the organization.
Example:
65099a0dd96fae8ab61130bf
campaign_id
string 
optional
Unique identifier for the campaign.
Example:
66eee42f9475e631ac0d1568
workspace_id
string 
optional
Unique identifier for the workspace.
Example:
65099a0dd96fae8ab61130c0
is_completed
integer 
optional
Indicates if the lead's process is completed. (1 = Completed)
Example:
1
current_step
integer 
optional
Current step in the lead's workflow.
Example:
1
email_account_id
string 
optional
Unique identifier for the associated email account.
created_at
string <date-time>
optional
Timestamp when the lead was created.
Example:
2024-09-14T06:29:55.185Z
modified_at
string <date-time>
optional
Timestamp when the lead was last modified.
Example:
2024-09-14T06:29:55.185Z
status
string 
optional
Status of the lead.
Example:
SKIPPED
label
string 
optional
Label associated with the lead.
email_acc_name
string 
optional
Name of the associated email account.
camp_name
string 
optional
Name of the campaign the lead belongs to.
Example:
Campaign Name Example
sent_step
integer 
optional
Step when the email was sent.
replied_count
integer 
optional
Number of replies received.
opened_count
integer 
optional
Number of times the email was opened.
last_sent_at
string <date-time>
optional
Timestamp of the last email sent.
is_mx
integer 
optional
Status of MX record check (-1 = Not Checked, 0 = Failed, 1 = Successful).
Example:
-1
mx
string 
optional
MX record details.
email
string 
optional
Lead's email address.
Example:
lead@abc.com
first_name
string 
optional
Lead's first name.
last_name
string 
optional
Lead's last name.
address_line
string 
optional
Address line of the lead.
Example:
200 Park Ave
city
string 
optional
City of the lead.
Example:
New York
state
string 
optional
State of the lead.
country
string 
optional
Country of the lead.
country_code
string 
optional
Country code of the lead.
phone_number
string 
optional
Phone number of the lead.
Example:
(021) 765-3710
job_title
string 
optional
Job title of the lead.
department
string 
optional
Department of the lead.
company_name
string 
optional
Company name of the lead.
Example:
ACME Company
company_website
string 
optional
Website of the lead's company.
Example:
https://company.com
industry
string 
optional
Industry of the lead.
linkedin_person_url
string 
optional
LinkedIn profile URL of the lead.
linkedin_company_url
string 
optional
LinkedIn company profile URL of the lead.
total_steps
integer 
optional
Total number of workflow steps for the lead.
Example:
4
Modified at 2025-05-24 05:40:10
Previous
Lead Variable/Label Update or Add
Next
Update the status of a lead
Built with