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

List all email accounts in the workspace

GET
https://api.plusvibe.ai/api/v1/account/list
Email Account
List all email accounts in the workspace
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.plusvibe.ai/api/v1/account/list?workspace_id&skip&limit&tags' \
--header 'x-api-key;'
Response Response Example
200 - Success
{
  "accounts": [
    {
      "_id": "6606d3a757aebe86b6dd8b9c",
      "email": "alice.smith@example.com",
      "status": "ACTIVE",
      "warmup_status": "ACTIVE",
      "timestamp_created": "2024-05-17T06:06:01.759Z",
      "timestamp_updated": "2024-08-14T13:08:37.344Z",
      "payload": {
        "name": {
          "first_name": "Bob",
          "last_name": "Johnson"
        },
        "warmup": {
          "limit": 75,
          "warmup_custom_words": "charity-dreamy",
          "warmup_signature": 0,
          "advanced": {
            "warm_ctd": true,
            "weekday_only": true,
            "warmup_business_type": ""
          },
          "increment": 2,
          "reply_rate": 40
        },
        "imap_host": "imap.gmail.com",
        "imap_port": 993,
        "smtp_host": "smtp.gmail.com",
        "smtp_port": 465,
        "daily_limit": 100,
        "sending_gap": 5,
        "reply_to": "",
        "custom_domain": "",
        "signature": "",
        "tags": []
      }
    },
    {
      "_id": "6634af3e716bada4a591a386",
      "email": "bob.johnson@example.com",
      "status": "ACTIVE",
      "warmup_status": "ACTIVE",
      "timestamp_created": "2024-05-03T09:32:44.243Z",
      "timestamp_updated": "2024-07-25T15:46:59.015Z",
      "payload": {
        "name": {
          "first_name": "Bob",
          "last_name": "Johnson"
        },
        "warmup": {
          "limit": 75,
          "warmup_custom_words": "charity-dreamy",
          "warmup_signature": 0,
          "advanced": {
            "warm_ctd": true,
            "weekday_only": true,
            "warmup_business_type": ""
          },
          "increment": 2,
          "reply_rate": 40
        },
        "imap_host": "imap.gmail.com",
        "imap_port": 993,
        "smtp_host": "smtp.gmail.com",
        "smtp_port": 465,
        "daily_limit": 100,
        "sending_gap": 5,
        "reply_to": "",
        "custom_domain": "",
        "signature": "",
        "tags": []
      }
    }
  ]
}

Request

Query Params
workspace_id
string 
required
Workspace ID
Default:
Example:
65f3c92d3dbe5dbb35374a9a
skip
integer 
optional
Optional - Offset for pagination
>= 0
Default:
Example:
limit
integer 
optional
Optional - Number of results to return
>= 1<= 100
Default:
Example:
10
tags
string 
optional
Optional - Allow 1 or more tag as filter, separated by comma (e.g. 6835fffd1710b6f930a27f47, 6835fffd1710b6f930a27f13)
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
accounts
array [object {7}] 
required
_id
string 
required
email
string 
required
status
string 
required
warmup_status
string 
required
timestamp_created
string 
required
timestamp_updated
string 
required
payload
object 
required
🟠400Bad Request
🔴500Server Error
Modified at 2025-06-25 05:30:22
Previous
Update the status of a lead
Next
Get email account status
Built with