Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Category Detail → Get One Category Detail

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific category. It is designed to fetch one category detail by its unique identifier, optionally including additional related details if requested.

Common scenarios for this node include:

  • Automating retrieval of category metadata in IT service management workflows.
  • Enriching tickets or records with category-specific information.
  • Synchronizing category data between Halo PSA and other systems.

For example, you might use this node to get the details of a category by its ID to display or process it further in your workflow, optionally including extended details depending on your needs.

Properties

Name Meaning
Id The unique numeric identifier of the category to retrieve.
Includedetails Optional flag to specify whether to include additional related details in the response.

Output

The node outputs JSON data representing the category detail retrieved from the Halo PSA API. The structure corresponds to the API's response for a single category, including fields such as category name, description, and any additional details if requested.

If the Includedetails property is set, the output JSON will contain extended information related to the category.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node configuration must include valid credentials containing base URL, tenant identifier, client ID, and client secret.
  • Network access to the Halo PSA API endpoint is necessary.

Troubleshooting

  • No credentials returned!: This error indicates missing or invalid API authentication credentials. Ensure that the API key credential is properly configured and linked to the node.
  • Resource or Operation not found: Occurs if the specified resource or operation does not exist in the node configuration. Verify that "Category Detail" is selected as the resource and "Get One Category Detail" as the operation.
  • Request errors from API: If the API returns errors (e.g., 404 Not Found for invalid category ID), check that the provided category ID exists and is correct.
  • JSON parsing errors: If additional query parameters or request bodies are malformed, ensure they are valid JSON when using advanced options.

Using the "Continue On Fail" option can help handle errors gracefully within workflows.

Links and References

Discussion