Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Organization → Search

AI-generated

Overview

This node interacts with the Magnet Customer API to perform a search operation on organizations. It allows users to search for organizations 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 organizations within a large dataset, such as in CRM or customer management workflows.

Use Case Examples

  1. Searching for organizations by name or keyword to retrieve matching entries.
  2. Paginating through organization search results to process or display them in batches.

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

Output

JSON

  • _id - Unique identifier of the organization.
  • fullname - Full name of the organization.
  • data - Additional data fields returned from the organization search.

Dependencies

  • Magnet Customer API
  • API authentication credentials (API Token or OAuth2)

Troubleshooting

  • Ensure the search string is at least 3 characters long to avoid validation errors.
  • Verify that the API credentials are correctly configured and have the necessary permissions to access organization data.
  • Handle pagination properly by setting the page and limit parameters to avoid missing or duplicating results.

Discussion