Actions253
- Platform: Account Actions
- Platform: Account User Actions
- Platform: Agent Bot Actions
- Platform: Banner Actions
- Platform: User Actions
- Account Actions
- Agent Actions
- Agent Bot (Account) Actions
- Automation Rule Actions
- Banner Message Actions
- Portal (Help Center) Actions
- Data Import Actions
- Dashboard App Actions
- CSAT Survey Response Actions
- Audit Log Actions
- Applied SLA Actions
- Reporting Event Actions
- Assignable Agents Actions
- Inbox Members Actions
- Search Actions
- Actions (contact/conversation) Actions
- Campaign Actions
- Call History Actions
- Canned Response Actions
- Chat Room Actions
- Contact Actions
- Contact Note Actions
- Conversation Actions
- Create
- Get
- List
- Send Message
- Send File
- Send with Template
- List Messages
- Delete Message
- List Attachments
- Download Attachment
- Assign Agent
- Assign Team
- Add Labels
- Remove Labels
- Update Labels
- List Labels
- Toggle Status
- Set Priority
- Add Custom Attributes
- Remove Custom Attributes
- Set Custom Attributes
- Update Last Seen
- Update Presence
- Mark Unread
- Update Attachment Metadata
- Mute
- Unmute
- Pin
- Unpin
- Send Transcript
- Filter
- Delete
- Custom Attribute Actions
- Custom Filter Actions
- Custom Resolution Reason Actions
- Custom Role Actions
- Custom Scheduled Message Type Actions
- Inbox Actions
- Integration Actions
- Label Actions
- Macro Actions
- Message Template Actions
- Notification Actions
- Profile Actions
- QuePasa Actions
- Report Actions
- Scheduled Message Actions
- SLA Policy Actions
- Team Actions
Search → Search
AI-generatedSummary
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