Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Custom Table → Get One Custom Table

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve data about custom tables defined in the system. Specifically, the "Get One Custom Table" operation fetches detailed information about a single custom table by its identifier. This is useful for scenarios where you need to programmatically access metadata or configuration of custom tables within Halo PSA, such as automating reporting, synchronizing data structures, or integrating with other systems that rely on custom table definitions.

Practical examples include:

  • Fetching a custom table's schema before importing or exporting data.
  • Retrieving details to display or process custom table configurations in an external dashboard.
  • Automating audits or validations of custom table setups.

Properties

Name Meaning
Id The unique numeric identifier of the custom table to retrieve.
Includedetails Optional flag (query parameter) indicating whether to include detailed information in the response.

Output

The node outputs JSON data representing the retrieved custom table. The structure corresponds to the Halo PSA API response for a single custom table, typically including fields such as the table's ID, name, description, and potentially detailed metadata if Includedetails is set.

If the request fails or encounters an error, the output JSON will contain an error field with the error message.

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 API requests via HTTP headers.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • Missing Credentials: 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 Custom Table not found" or "Operation Get One Custom Table not found for resource Custom Table" indicate misconfiguration of parameters. Verify that the resource and operation names are correctly set.
  • Invalid Id Parameter: Since the Id property is required and numeric, providing an invalid or missing ID will cause the API call to fail. Make sure to supply a valid custom table ID.
  • API Request Failures: Network issues, incorrect base URL, or authentication failures will result in errors from the API request. Check connectivity and credential correctness.
  • JSON Parsing Errors: If additional JSON parameters are used elsewhere, malformed JSON strings can cause parsing errors. For this operation, this is less likely but still possible if extended.

Using the node's "Continue On Fail" option can help handle errors gracefully in workflows.

Links and References

Discussion