Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

SQL Import → List Of SQL Import

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the SQL Import resource and the List Of SQL Import operation, it retrieves a list of SQL import records from the Halo PSA system.

Typical use cases include:

  • Automating retrieval of SQL import data for reporting or synchronization.
  • Filtering SQL imports based on client ID overrides, integrator enabled status, or whether only positive results should be shown.
  • Integrating SQL import data into workflows that require up-to-date import statuses or details.

For example, a user might want to fetch all SQL imports where the integrator is enabled and only show positive results to monitor successful data imports.

Properties

Name Meaning
Clientidoverride A string to override the client ID filter when listing SQL imports.
Integratorenabled Filter to include only SQL imports where the integrator is enabled (true/false).
Showpositiveonly Filter to include only SQL imports with positive results (true/false).

These properties are sent as query parameters in the API request to filter the list of SQL imports accordingly.

Output

The node outputs an array of JSON objects representing the SQL import records retrieved from the Halo PSA API. Each item corresponds to one SQL import entry and contains fields as returned by the API.

The output structure is:

[
  {
    "id": "...",
    "clientId": "...",
    "integratorEnabled": true,
    "status": "...",
    "otherFields": "..."
  },
  ...
]

(Note: The exact fields depend on the Halo PSA API response schema.)

No binary data is output 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 custom headers.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot retrieve the required API credentials. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    Indicates an invalid resource or operation name was specified. Verify that "SQL Import" is selected as the resource and "List Of SQL Import" as the operation.

  • API request errors
    If the API returns an error (e.g., authentication failure, bad request), the node will throw an error unless "Continue On Fail" is enabled. Check the credentials and query parameter values.

  • Invalid query parameters
    Passing incorrect types or malformed values for filters like integratorenabled or showpositiveonly may cause API errors. Use boolean values or appropriate strings as expected by the API.

Links and References

Discussion