Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Pipeline → Search

AI-generated

Overview

This node operation allows searching pipelines within the Magnet Customer API. It supports filtering pipelines based on search terms and the presence of emails, phones, and interactions. Additionally, it supports sorting the search results by specified fields and directions, and paginating through results with page and limit parameters. This operation is useful for users who want to find specific pipelines matching certain criteria or to browse pipelines in a controlled, sorted manner.

Use Case Examples

  1. Search pipelines containing a specific keyword in their title or description.
  2. Filter pipelines to only those that have associated emails or interactions.
  3. Sort pipelines by creation date in descending order and limit the results to 10 per page.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Filters Collection of filters to narrow down the search results for pipelines.
Sort Sorting options for the search results.
Page Page number of the search results to retrieve.
Limit Maximum number of results to return per page.

Output

JSON

  • _id - Unique identifier of the pipeline.
  • title - Title of the pipeline.
  • createdAt - Creation date of the pipeline.
  • emailsEmpty - Indicates if the pipeline has emails or not.
  • phonesEmpty - Indicates if the pipeline has phones or not.
  • interactionsEmpty - Indicates if the pipeline has interactions or not.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the API credentials (API Token or OAuth2) are correctly configured and valid.
  • Check that the search filters are correctly formatted and supported by the API.
  • If no results are returned, verify that the search term and filters match existing pipelines.
  • Pagination parameters (page and limit) should be within valid ranges to avoid errors.

Discussion