Search Query

We use this string format for our searches. Supported parameters are:


is	String	Filters messages based on activity status (e.g. 'opened', 'clicked', 'downloaded', 'replied', 'bounced'), as well as special operators 'internal' (whether the message is from and to the domain of the owning user) and 'private' (whether the message has been shared in the team live feed).
to	String	Filters messages based on recipients. Accepts email addresses and domains.
from	String	Filter messages based on the sending address. Accepts email addresses, team names, and special values 'me', 'myself' and 'everyone'.
subject	String	Filter messages based on subject.
sequence	String	Filter messages based on the sequence they belong to (by name). Also accepts '*', which means any sequence.
template	String	Filter messages based on the template used (by name). Also accepts '*', which means any template.
sent	String	Filter messages based on when they were sent. Accepts a date range string in the form `MM/DD/YYYY-MM/DD/YYYY`, or a special keyword such as 'yesterday'.
salesforceAccount	String	Filter messages to those sent to members of this Salesforce account (by name).
salesforceOpportunity	String	Filter messages to those sent to members of this Salesforce opportunity (by name).
rsvp	String	Filter messages to those where the recipient replied to a meeting invitation with this response. Accepts 'yes', 'no', 'maybe' and 'noresponse'.

Response Format

Parameter	Type	Description
results	Array	Array of messages matching the query
results._id	String	Unique message ID
results.userId	String	The ID of the user who owns the message
results.recipients	Array	Array of message message recipients. Contains all recipients (`to`, `cc` and `bcc`).
results.recipients.email	String	The email of the recipient.
results.recipients.name	String	The name of the recipient.
results.fromEmail	String	The email address the message was sent from.
results.fromName	String	The name the message was sent from.
results.subject	String	The subject of the message.
results.sent	Integer	Timestamp the message was sent (ms).
results.service	String	The service the message was sent via e.g. 'gmail'.
results.serviceMessageId	String	The ID of the message on the service.
results.serviceThreadId	String	The ID of the thread on the service.
results.includeInTeamLiveFeed	Integer	Whether the message is shown in the team live feed.
results.showContentTeamLiveFeed	Integer	Whether the message content is visible in the team live feed.
results.trackingMuted	Integer	Whether tracking is muted on this message.
results.numOpens	Integer	Total number of opens on the message (across all recipients).
results.numClicks	Integer	Total number of clicks on the message (across all recipients).
results.numDownloads	Integer	Total number of downloads on the message (across all recipients).
results.wasReplied	Integer	Whether the message has had a reply.
results.wasAccepted	Integer	Whether a meeting invite in this message has been accepted.
results.wasDeclined	Integer	Whether a meeting invite in this message has been declined.
results.wasTentative	Integer	Whether a meeting invite in this message has been tentatively accepted.
results.wasBounced	Integer	Whether the message has bounced.
results.lastEventType	String	The type of the most recent event (e.g. 'opened').
results.lastEventAt	Integer	Timestamp the last event occurred (ms).
results.lastEventByEmail	String	The email address of the recipient who triggered the most recent event.
results.lastEventByName	String	The name of the recipient who triggered the most recent event.
results.permalink	String	A permalink to this message.
hasNext	Boolean	Whether there is a next page of results.
hasPrevious	Boolean	Whether there is a previous page of results.
next	String	The paging token to use to retrieve the next page of results.
previous	String	The paging token to use to retrieve the previous page of results.
stats	Object	Aggregate stats for the live feed query.

200200

400400