Introduction

Emails | List

Note: The body of the email object is only sent when you have preview_only=false (i.e., the default state is to send the content preview only). The body object may have a property called text and/or html, depending on the original content of the email.

The email_type parameter now accepts a new value manual. When applied, it will return the following email types:

Sent manually through the Unibox
Received emails (responses from leads)
Emails scheduled to be sent (from the Unibox)

Query Parameters

api_keystring Required

Your API Key

preview_onlystring

Set to false if you only want the email content's preview and not the full body

leadstring

Email address of lead (optional) - only fetch emails for a specific lead

campaign_idstring

Campaign id (optional) - only fetch emails for a specific campaign

sent_emailsstring

Set to true if you only want to fetch sent emails - only

email_typestring

Email type, read below for details

Enum values:

sent

A sent email - either through a campaign, or in Unibox

received

A received email - either a campaign response, or manual response

all

All types of emails

manual

Any type of email EXCEPT emails sent by campaigns

latest_of_threadstring

Set to true if you want to only fetch the latest email per thread

page_trailstring

Used for pagination - returned in the response

Response

200

Object

Response Attributes

page_trailstring

Used for pagination - you can pass this on to fetch the next page

dataarray

Show child attributes

Sections

Emails | List

Query Parameters

Response

Response Attributes

What made this section unhelpful for you?

Language Box

Response

What made this section unhelpful for you?

Sections

Emails | List

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Language Box

Response

What made this section unhelpful for you?

Response