Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Task → Search

AI-generated

Overview

This node performs a search operation on tasks within the Magnet Customer API. It allows users to search for tasks 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 tasks quickly, such as filtering tasks by keywords or managing task lists efficiently.

Use Case Examples

  1. Searching for tasks containing a specific keyword or phrase.
  2. Retrieving a paginated list of tasks to display in a dashboard or report.

Properties

Name Meaning
Authentication Selects the authentication method to use for the API request, either API Token or OAuth2.
Search The search string to look for in tasks. Must be at least 3 characters long.
Page The page number of the search results to retrieve.
Limit The maximum number of search results to return, with a minimum value of 15.

Output

JSON

  • _id - Unique identifier of the task.
  • name - Name or title of the task.
  • description - Description or details of the task.
  • status - Current status of the task.
  • dueDate - Due date of the task.
  • assignedTo - Information about the staff or user assigned to the task.
  • createdAt - Timestamp when the task was created.
  • updatedAt - Timestamp when the task was last updated.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the search string is at least 3 characters long to avoid validation errors.
  • Verify that the authentication credentials (API Token or OAuth2) are correctly configured and valid.
  • Check API rate limits and handle pagination properly to avoid incomplete results.
  • If custom fields are used, ensure they are correctly resolved if the option is enabled, otherwise IDs may be returned instead of names.

Discussion