API Email - History
Last updated
Last updated
POST
/v2/email/search
Body
Param | Type | Description |
---|---|---|
Response
{
"current_page": 1,
"from": 1,
"to": 1,
"total": 4,
"data": [
{
"id": 1,
"uuid": "14e60762992ef2aeb13038a8fb08ffd5",
"user_id": 1,
"agent_id": 1000,
"hidden": 0,
"provider": "outlook", // outlook, gmail or smtp
"folder": "Inbox",
"type": "inbound", // inbound or outbound
"eid": "EMAIL_CHAIN_ID_HERE",
"uid": "UNIWUE_EMAIL_ID_HERE",
"from_email": "from@email.com",
"to_email": [
{
"name": "John Doe",
"email_address": "to@email.com"
}
],
"subject": "Sending Email Eample",
"text_body": "BASE_64_ENCODED_STRING",
"html_body": "BASE_64_ENCODED_STRING",
"headers": [
{ // Possible outputs, custom to whats sent.
"sense_customer_id": 123456,
"sense_order_id": 123456
// ...
}
],
"cc": [
{
"name": "Another Person",
"email_address": "cc1@email.com"
}
],
"bcc": [], // Same pattern as CC
"is_draft": 0, // True/False
"is_read": 1, // True/False
"summary": "Summary of the Email Chain here",
"actions": [
{
"type": "email",
"task": "Example task here",
"period": "ASAP" // TODAY, ASAP, THIS_WEEK, NEXT_WEEK or Specific Date [YYYY-MM-DD H:i:s]
}
],
"spam": 0, // 0-100
"scam": 0, // 0-100
"junk": 0, // 0-100
"tags": [
"technical",
"b2b",
"internal",
"follow_up",
"product_update"
],
"priority": "medium", // low, medium, high
"date": "2024-11-21 18:51:03", // Date the email landed
"created_at": "2024-11-21T23:15:33.000000Z",
"updated_at": "2024-11-21T23:15:48.000000Z"
},
],
}
{
"error": "Invalid request"
}
api_key
string
required
email_address
string
Email Address lookup required
page
int
uuid
string
Return Single Email From UUID
eid
string
Return Emails from eid [Chain]