Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Deal → Search

AI-generated

Overview

This node performs a search operation on deals within the Magnet Customer API. It allows users to search for deals 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 retrieving specific deals matching certain criteria, such as deal titles or other searchable fields, enabling efficient deal management and lookup in CRM workflows.

Use Case Examples

  1. Search for deals containing the keyword 'important' to quickly find relevant sales opportunities.
  2. Paginate through deal search results to process or analyze deals in batches of 15 per page.

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 deals. Must be at least 3 characters.
Page The page number of results to retrieve, used for pagination.
Limit Maximum number of deal results to return per page, minimum 15.

Output

JSON

  • _id - Unique identifier of the deal.
  • title - Title or name of the deal.
  • otherProperties - Additional properties of the deal returned by the API, depending on the search results.

Dependencies

  • Magnet Customer API with either API Token or OAuth2 authentication

Troubleshooting

  • Ensure the search string is at least 3 characters long to avoid validation errors.
  • Check API credentials and permissions if authentication fails.
  • If no results are returned, verify the search criteria and pagination parameters.

Links

Discussion