PlusVibe.ai
  1. Unibox
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 email account status
    • Check account vitals
    • Enable Email account warmup
    • Pause Email account warmup
    • Delete Email account
    • Get Warmup Stats (Individual Account)
    • Get Warmup Stats (Workspace-Level)
    • Bulk Add SMTP Accounts
  • Analytics
    • Get campaign summary
    • Get campaign count (deprecated)
    • Get campaign stats
    • Get all campaigns statistics
  • Unibox
    • Get emails
      GET
    • Get count of unread emails
      GET
    • Reply to an email
      POST
    • Forward an existing email
      POST
    • Mark email read
      POST
  • 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. Unibox

Get emails

GET
https://api.plusvibe.ai/api/v1/unibox/emails
Unibox
Get emails
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.plusvibe.ai/api/v1/unibox/emails?workspace_id' \
--header 'x-api-key;'
Response Response Example
200 - Example 1
{
    "page_trail": "66b9d78ff91fabf920f6964d",
    "data": [
        {
            "id": "66b9d78ff91fabf920f6964d",
            "message_id": "<ab76062c-3f46-4583-15dd-86aba3f13d83@account.com>",
            "is_unread": 0,
            "lead": "lead@example.com",
            "lead_id": "65f3c92d3dbe5dbb35374a9a",
            "campaign_id": "668627fc3f30909b2ae9bd61",
            "from_address_email": "lead@example.com",
            "from_address_json": [
                {
                    "address": "lead@example.com",
                    "name": "string"
                }
            ],
            "subject": "RE: plusvibe.ai | 80% positive reply rate campaign and how you can do the same",
            "headers": [
                {
                    "name": "Content-Type",
                    "value": "text/html; charset=utf-8"
                }
            ],
            "timestamp_created": "2024-08-13T11:58:18.000Z",
            "content_preview": "I'm interested. Please send me more info. Thanks.",
            "label": "MEETING_BOOKED",
            "thread_id": "66bb4a71e9bbd11ef367b940",
            "eaccount": "sender@account.com",
            "to_address_email_list": "sender@account.com",
            "to_address_json": [
                {
                    "address": "sender@account.com",
                    "name": "string"
                }
            ],
            "cc_address_email_list": "cc@example.com",
            "cc_address_json": [
                {
                    "address": "cc@example.com",
                    "name": "CC User"
                }
            ],
            "bcc_address_email_list": "bcc@example.com",
            "source_modified_at": "2024-08-13T11:58:18.000Z",
            "body": {
                "text": "I'm interested. Please send me more info. Thanks.",
                "html": "<div>I'm interested. Please send me more info. Thanks.</div>"
            }
        }
    ]
}

Request

Query Params
workspace_id
string 
required
Workspace ID
Default:
Example:
65f3c92d3dbe5dbb35374a9a
preview_only
enum<string> 
optional
Set to true if you only want the email content's preview and not the full body
Allowed values:
truefalse
Default:
Example:
true
lead
string <email>
optional
Optional - Enter the email address of the lead to fetch emails only for that specific lead.
Default:
Example:
lead@example.com
campaign_id
string 
optional
Optional - only fetch emails for a specific campaign
Default:
Example:
65f3c92d3dbe5dbb35374a9b
email_type
enum<string> 
optional
Optional- Specifies the type of emails to retrieve. Options include all emails, received emails, or sent emails. Sent emails include only those replied directly from Unibox. For sent campaign emails, please use the campaign-emails endpoint.
Allowed values:
allreceivedsent
Default:
Example:
all
page_trail
string 
optional
Optional - Token for fetching the next page of results. Use the page_trail value from the previous response to fetch the next page.
Default:
Example:
label
string 
optional
Optional - The label of the email should be in all capital letters, with spaces replaced by underscores
Default:
Example:
MEETING_BOOKED
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
page_trail
string 
optional
Token for fetching the next page of results
Example:
66b9d78ff91fabf920f6964d
data
array [object {22}] 
optional
id
string 
optional
Use this ID for reply.
Example:
66b9d78ff91fabf920f6964d
message_id
string 
optional
the email's raw message ID
Example:
<ab76062c-3f46-4583-15dd-86aba3f13d83@account.com>
is_unread
integer <int32>
optional
Example:
0
lead
string 
optional
Email address of the lead
Example:
lead@example.com
lead_id
string 
optional
Unique ID of the lead
Example:
65f3c92d3dbe5dbb35374a9a
campaign_id
string 
optional
Campaign ID
Example:
668627fc3f30909b2ae9bd61
from_address_email
string 
optional
Example:
lead@example.com
from_address_json
array [object {2}] 
optional
subject
string 
optional
Example:
RE: plusvibe.ai | 80% positive reply rate campaign and how you can do the same
headers
array [object {2}] 
optional
timestamp_created
string <date-time>
optional
Example:
2024-08-13T11:58:18.000Z
content_preview
string 
optional
Example:
I'm interested. Please send me more info. Thanks.
label
string 
optional
The label of the email is in all capital letters, with spaces replaced by underscores.
Example:
MEETING_BOOKED
thread_id
string 
optional
Example:
66bb4a71e9bbd11ef367b940
eaccount
string 
optional
Example:
sender@account.com
to_address_email_list
string 
optional
Example:
sender@account.com
to_address_json
array [object {2}] 
optional
cc_address_email_list
string 
optional
Example:
cc@example.com
cc_address_json
array [object {2}] 
optional
bcc_address_email_list
string 
optional
Example:
bcc@example.com
source_modified_at
string <date-time>
optional
Example:
2024-08-13T11:58:18.000Z
body
object 
optional
🟠400Bad Request
🔴500Server Error
Modified at 2025-05-24 05:40:10
Previous
Get all campaigns statistics
Next
Get count of unread emails
Built with