Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Workspace → Search

AI-generated

Overview

This node performs a search operation on workspaces using the Magnet Customer API. It allows users to search for workspaces based on a search term and apply various filters such as whether emails, phones, or interactions are empty. Users can also control pagination with page and limit parameters, and sort the results by specified fields in ascending or descending order. This node is useful for retrieving specific workspace data efficiently, for example, when looking for workspaces matching certain criteria or when managing workspace records in bulk.

Use Case Examples

  1. Searching for workspaces containing a specific keyword in their name or description.
  2. Filtering workspaces that have no associated emails or phone numbers.
  3. Sorting workspaces by creation date in descending order and limiting the results to 15 per page.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Page The page number of results to retrieve, used for pagination.
Limit Maximum number of workspace results to return per request.
Search Term The term to search for within workspaces.
Filters Filters to apply to the workspace search, including whether emails, phones, or interactions are empty.
Sort Sorting options for the search results, including the field to sort by and the sort direction.

Output

JSON

  • _id - Unique identifier of the workspace.
  • name - Name of the workspace.
  • emails - Emails associated with the workspace.
  • phones - Phone numbers associated with the workspace.
  • interactions - Interactions related to the workspace.
  • createdAt - Creation date of the workspace.
  • updatedAt - Last update date of the workspace.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the API credentials (API Token or OAuth2) are correctly configured and valid.
  • Verify that the search term and filters are correctly formatted and supported by the API.
  • If no results are returned, check the pagination parameters (page and limit) and adjust accordingly.
  • If the node throws errors, enable debug logging to get more detailed error messages and trace the issue.

Discussion