Search conversations

Search for conversations. Response will include a count of total matches and an array of conversations in descending order by last activity.

️ Deprecated field included

This endpoint returns a deprecated last_message field in the top-level conversation bodies listed. Please use the
_links.related.last_message field instead.

Supported Search Modifiers

The query you provide can be as simple as a keyword search such as san francisco, but can also make use of any of the following modifiers. It's important to note that:

  • Keyword search is performed by exact matching against message recipients, subjects, bodies, and comments. You can use quotes to search for exact phrases (e.g. "new york city" as opposed to new york city).
  • Supplying multiple instances of the from, to, cc or bcc modifiers will result in an OR operation. For example, from:[email protected] from:[email protected] would return conversations from either [email protected] or [email protected]
  • Supplying different modifiers will result in an AND operation. For example inbox:inb_123 tag:tag_456 would return conversations that are in the specified inbox and have the tag applied.

Matching conversations will be returned in reverse chronological order based on the most recent activity of the conversation.

Modifier

Input format

Examples

Inbox

inbox:{inbox_id}

If omitted, the search will be performed in all accessible inboxes. To search within personal inboxes, private resource access must be enabled.

inbox:inb_abc

Tag

tag:{tag_id}

tag:tag_123

Topic

topic:{topic_id}

topic:top_123

Contact

contact:{contact_id} or contact:{contact_resource_alias}

contact:crd_123, contact:alt:phone:+1234567890

recipient, from, to cc, bcc

recipient:{string}

recipient:john, cc:[email protected]

participant, assignee, author, mention, commenter

participant:{teammate_id} or participant:{teammate_resource_alias}

participant:tea_123, assignee:tea_456, commenter:alt:email:[email protected]

Status

is:{Status}

Status must be one of: assigned, unassigned, archived, deleted, open, snoozed, unreplied

Example: is:archived

is:deleted

Dates

before:{timestamp}, after:{timestamp}, on:{timestamp}, during:{timestamp}

on and during will resolve timestamps to a day.

timestamp should be formatted as an unix timestamps in seconds

before:1454453901, on:1454453901

Example Queries

Below are a few example queries and associated descriptions. Note that since the query you construct must be provided as a query parameter, it must be properly encoded using something like encodeUriComponent.

Query

Description

inbox:inb_abc on:1619697600 "san francisco"

Conversations with activity on April 29th, 2021 that are in inbox inb_abc and that contain the exact phrase "san francisco".

shipment received

Conversations in any inbox with both the words "shipment" and "received", but not necessarily in that order.

assignee:alt:email:[email protected] tag:tag_123

Conversations in any inbox with the tag tag_123 and that are assigned to the teammate with email address [email protected]

Limitations

  • Searching within the content of attachments such as PDFs is not currently supported through the API
  • Backward pagination is not currently supported
Language
Authentication
Bearer
JWT