Actions104
- Custom Field Actions
- Custom Field Block Actions
- Custom Field Type Actions
- Customer Actions
- Deal Actions
- Lead Actions
- Meeting Actions
- Meeting Room Actions
- Meeting Type Actions
- Organization Actions
- Pipeline Actions
- Prospect Actions
- Staff Actions
- Task Actions
- Ticket Actions
- Treatment Actions
- Treatment Type Actions
- Workspace Actions
Customer → Search
AI-generatedOverview
This node performs a search operation on the Customer resource using the Magnet Customer API. It allows users to search for customers based on a search string, with options to paginate results by specifying the page number and limit of results per page. This is useful for scenarios where you need to find specific customers or filter customers based on search criteria, such as retrieving customer details for follow-up or analysis.
Use Case Examples
- Search customers by name or email containing a specific keyword.
- Retrieve a paginated list of customers matching a search term for CRM integration.
Properties
| Name | Meaning |
|---|---|
| Authentication | Selects the authentication method to use for the API request (API Token or OAuth2). |
| Search | The search string to look for in customers. Must be at least 3 characters. |
| Page | The page number of the search results to retrieve. |
| Limit | The maximum number of customer results to return per page, minimum 15. |
Output
JSON
_id- Unique identifier of the customer.fullname- Full name of the customer.email- Email address of the customer.phone- Phone number of the customer.customFields- Custom fields associated with the customer, if resolved.
Dependencies
- Magnet Customer API
Troubleshooting
- Ensure the search string is at least 3 characters long to avoid validation errors.
- Check API authentication credentials (API Token or OAuth2) if requests fail due to authorization errors.
- If custom fields are not resolved correctly, verify the 'Resolve Custom Fields' option and API permissions.