Actions68
- Custom Field Actions
- Custom Field Block Actions
- Custom Field Type Actions
- Customer Actions
- Deal Actions
- Lead Actions
- Organization Actions
- Pipeline Actions
- Prospect Actions
- Staff Actions
- Task Actions
- Workspace Actions
Overview
The "Prospect Search" operation in the Magnet Customer node allows users to search for prospects within the Magnet Customer system by specifying a search string. This operation is useful for retrieving prospect records that match certain criteria, such as names or other identifying information. It supports pagination and limiting the number of results returned.
Typical use cases include:
- Finding specific prospects based on partial or full text queries.
- Integrating prospect lookup into automated workflows for sales or marketing.
- Retrieving a manageable subset of prospects for further processing or analysis.
For example, a user might search for prospects whose names contain "John" and retrieve up to 50 matching records starting from page 0.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use: "API Token" or "OAuth2". |
| Search | The search string to look for in prospects. Must be at least 3 characters long. |
| Page | The page number of results to return (for pagination). Defaults to 0 (first page). |
| Limit | Maximum number of results to return. Minimum value is 15. |
| Source | Hidden property indicating the source of the contact; default is "n8n". |
| Life Cycle | Hidden property indicating the life cycle stage of the contact; default is "prospect". |
Note: The properties "Source" and "Life Cycle" are hidden and set internally to fixed values relevant to the prospect resource.
Output
The output is a JSON array where each item represents a prospect record matching the search criteria. Each JSON object contains the data fields returned by the Magnet Customer API for prospects.
The node does not explicitly output binary data for this operation.
Dependencies
- Requires an active connection to the Magnet Customer API.
- Supports two authentication methods: API token or OAuth2 credentials.
- The user must configure appropriate credentials in n8n to authenticate requests.
Troubleshooting
- Search string too short: The search input requires a minimum of 3 characters. Providing fewer will likely cause errors or no results.
- Authentication errors: If the API token or OAuth2 credentials are invalid or expired, the node will fail to authenticate. Ensure credentials are correctly configured and valid.
- Pagination issues: Setting the page or limit incorrectly may result in unexpected numbers of results or empty responses.
- API rate limits: Excessive requests may trigger rate limiting on the Magnet Customer API side, causing errors or delays.
If errors occur, check the error message returned by the node for clues, verify credentials, and ensure the search parameters meet requirements.
Links and References
- Magnet Customer API Documentation (example placeholder link)
- n8n documentation on creating custom nodes
- OAuth2 and API token authentication best practices in n8n
This summary is based solely on static analysis of the provided source code and property definitions.