Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Item → Get One Item

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a single item identified by its ID. It is designed for scenarios where you need to fetch specific item data from the Halo PSA system, such as inventory management, asset tracking, or service ticket referencing.

Practical examples include:

  • Fetching an item's details before updating or processing it in a workflow.
  • Retrieving item metadata to display or log within an automation.
  • Using item data to cross-reference with other systems or databases.

Properties

Name Meaning
Id The unique numeric identifier of the item to retrieve (required).
Dbc Company Id Optional string query parameter to specify the DBC company context for the request.
Includedetails Boolean flag indicating whether to include extra related objects/details in the response.
Kashflowtenantid Optional query parameter for specifying the Kashflow tenant ID context.
Qbocompanyid Optional string query parameter for specifying the QuickBooks Online company ID.
Sagebusinesscloudtenantid Optional query parameter for specifying the Sage Business Cloud tenant ID.
Xerotenantid Optional string query parameter for specifying the Xero tenant ID.

These properties are sent as query parameters along with the request to customize and filter the returned item data.

Output

The node outputs a JSON object representing the retrieved item. This JSON includes all standard fields of the item as provided by the Halo PSA API, potentially enriched with additional details if the Includedetails property is set to true.

The output structure corresponds directly to the API's item schema and may contain nested objects depending on the included details.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate requests via custom headers.
  • No additional external services or environment variables are required beyond the configured API credentials.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node will throw an error stating "No credentials returned!". Ensure that the API key credential is properly configured in n8n.
  • Resource or Operation Not Found: Errors like "Resource Item not found" or "Operation Get One Item not found for resource Item" indicate misconfiguration of the resource or operation names.
  • Invalid ID Parameter: Since the Id property is required and must be a number, providing an invalid or missing ID will cause the request to fail.
  • API Request Failures: Network issues, incorrect tenant IDs, or insufficient permissions can cause the API call to fail. The node will return the error message from the API in the output JSON when continueOnFail is enabled.
  • JSON Parsing Issues: If additional query parameters or request bodies are provided as JSON strings, ensure they are correctly formatted to avoid parsing errors.

Links and References

Discussion