Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Lead → Search

AI-generated

Overview

This node performs a search operation on leads within the Magnet Customer API. It allows users to search for leads 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 users need to find specific leads quickly, such as in sales or marketing workflows where lead data is critical.

Use Case Examples

  1. Searching for leads containing a specific keyword or name to follow up on potential customers.
  2. Retrieving a paginated list of leads matching certain criteria for reporting or analysis.

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 leads. Must be at least 3 characters.
Page The page number of results to retrieve for pagination.
Limit Maximum number of lead results to return, with a minimum of 15.

Output

JSON

  • _id - Unique identifier of the lead.
  • fullname - Full name of the lead.
  • email - Email address of the lead.
  • phone - Phone number of the lead.
  • status - Current status of the lead.
  • source - Source from which the lead was acquired.
  • createdAt - Timestamp when the lead was created.
  • updatedAt - Timestamp when the lead was last updated.

Dependencies

  • Magnet Customer API
  • API Token or OAuth2 credentials

Troubleshooting

  • Ensure the search string is at least 3 characters long to avoid validation errors.
  • Check that the API credentials (API Token or OAuth2) are correctly configured and have the necessary permissions.
  • If no results are returned, verify that the search criteria match existing leads in the Magnet Customer system.
  • Handle API rate limits or connectivity issues by implementing retry logic or error handling in the workflow.

Links

Discussion