Search conversations with the Front API

Searches the conversations the API token can reach, most recent activity first, and returns _total with the matches. Trashed conversations are left out unless the query asks for is:trashed. The next page comes from the page_token inside _pagination.next, which is null on the last page.

Identifier
front_search_conversations

The request

POST https://connect.reportei.com/api/tools/front_search_conversations/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "query": "<query>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
querystringYesWords and filters separated by spaces, combined with AND. Words match subject and body; quote a phrase. Filters: is:open, is:archived, is:assigned, is:unassigned, is:snoozed, is:unreplied, is:waiting, is:resolved, is:trashed; inbox:ID (List inboxes); tag:ID (List tags); assignee:ID or participant:ID (List teammates); from:, to:, cc: or recipient: with an email or handle; before:, after: or during: with a Unix time in seconds. Up to 15 filters.
limitintegerNoResults per page, up to 100. Defaults to 50.
page_tokenstringNoThe page_token value in the _pagination.next URL of the previous response.

Supported connections

Your customer connects their Front account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/front_search_conversations. It becomes your agent's tool definition with no conversion.

Other Front tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.