Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Treatment Type → Search

AI-generated

Overview

This node interacts with the Magnet Customer API to perform a search operation on Treatment Types. It allows users to search for treatment types based on a search string, with pagination support through page and limit parameters. This is useful for retrieving specific treatment types from a large dataset, for example, when integrating treatment type data into workflows for healthcare or wellness applications.

Use Case Examples

  1. Search for treatment types containing a specific keyword to display relevant options in a user interface.
  2. Retrieve a paginated list of treatment types to process or analyze in a workflow.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Search The search string to filter treatment types by name or other attributes.
Page The page number of the search results to retrieve.
Limit The maximum number of treatment type results to return per page, with a minimum of 15.

Output

JSON

  • _id - Unique identifier of the treatment type.
  • name - Name of the treatment type.
  • description - Description of the treatment type.
  • createdAt - Timestamp when the treatment type was created.
  • updatedAt - Timestamp when the treatment type was last updated.

Dependencies

  • Magnet Customer API
  • API Token or OAuth2 credentials

Troubleshooting

  • Ensure the API credentials (API Token or OAuth2) are correctly configured and valid to avoid authentication errors.
  • Verify that the search string is correctly formatted and not empty if filtering is intended.
  • Check the page and limit parameters to ensure they are within acceptable ranges to avoid pagination errors.
  • If the node returns empty results, confirm that the search criteria match existing treatment types in the Magnet Customer system.

Discussion