Chat icon

Chat

Interact with the Chat API

Actions253

Search → Search

AI-generated

Summary

Searches the Approach platform for records matching a query, optionally filtered by type, and returns the results.

Inputs

  • accountId (required) — Select the Approach account to use.
  • query — Search query string.
  • type — Optional type filter. Options: All (empty), Contact, Conversation, Message.
  • returnAll — If true, return all matching results; otherwise limit results by Limit.
  • limit — Maximum number of results to return when Return All is false. Default 50.

Output shape

array

Array of search result objects. Each object includes at least an id and a type field, with additional fields varying by type (e.g., for Contact: name, email; for Conversation: id, status; for Message: content, timestamp).

Examples

Example 1: Search for contacts containing the term 'acme' limited to 10 results

accountId = selected account, query = 'acme', type = 'Contact', returnAll = false, limit = 10

Example 2: Retrieve all messages containing 'refund' across the account

accountId = selected account, query = 'refund', type = 'Message', returnAll = true

Links

Discussion