Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Prospect → Search

AI-generated

Overview

This node performs a search operation on the 'Prospect' resource using the Magnet Customer API. It allows users to search for prospects 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 prospects or filter prospects based on search criteria within a CRM or customer management workflow.

Use Case Examples

  1. Searching for prospects whose names or details match a given search term, e.g., 'John Doe'.
  2. Paginating through prospect search results to retrieve a manageable number of entries per request.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Search The search string to look for in prospects. Must be at least 3 characters.
Page The page number of the search results to retrieve.
Limit The maximum number of search results to return, with a minimum of 15.

Output

JSON

  • _id - Unique identifier of the prospect.
  • fullname - Full name of the prospect.
  • email - Email address of the prospect.
  • phone - Phone number of the prospect.
  • company - Company associated with the prospect.
  • customFields - Custom fields related to the prospect, resolved if the option is enabled.

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 resolving correctly, verify the 'Resolve Custom Fields' option and API permissions.

Discussion