Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

View Filter → List Of View Filter

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the View Filter resource and the List Of View Filter operation, it retrieves a list of view filters based on optional query parameters. This is useful in scenarios where you want to programmatically fetch and filter views or saved filters from the Halo PSA system, such as automating reporting, dashboard generation, or syncing view filters with other systems.

For example, you might use this node to:

  • Retrieve all global view filters.
  • List filters specific to a ticket area or type.
  • Fetch filters visible to certain teams or technicians.

Properties

Name Meaning
Globalonly Filter to include only global view filters (true/false).
Showall Option to show all view filters regardless of other filters (true/false).
Showallforteam Include all view filters available for the team (true/false).
Showallfortech Include all view filters available for the technician (true/false).
Ticketarea Id Filter view filters by a specific ticket area ID (string or number).
Type Filter view filters by type (string).

All these properties are sent as query parameters to the API request when listing view filters.

Output

The node outputs an array of JSON objects representing the view filters retrieved from the Halo PSA API. Each item corresponds to one view filter and contains its details as returned by the API.

If the API supports binary data for this operation (not indicated here), it would be included accordingly, but for this operation, output is purely JSON.

Example output structure (simplified):

[
  {
    "id": "123",
    "name": "My View Filter",
    "type": "someType",
    "globalonly": true,
    "ticketarea_id": "456",
    ...
  },
  ...
]

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials including base URL, tenant identifier, client ID, and client secret.
  • The node uses HTTP requests with appropriate headers for authentication.
  • No additional external dependencies beyond the n8n environment and the provided credentials.

Troubleshooting

  • No credentials returned!
    Ensure that valid API credentials are configured in n8n before running the node.

  • Resource or Operation not found errors
    Verify that the Resource is set to "View Filter" and Operation to "List Of View Filter". These must match exactly.

  • API request failures
    Check network connectivity and API endpoint correctness. Also verify that the credentials have sufficient permissions.

  • JSON parsing errors
    If using advanced query parameters or JSON input fields, ensure they are correctly formatted JSON strings.

  • Empty results
    Confirm that the query parameters used actually match existing view filters in the Halo PSA system.

Links and References

Discussion