Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Dashboard Links → List Of Dashboard Links

AI-generated

Overview

This node integrates with the Halo PSA API to list dashboard links. It allows users to retrieve a filtered and paginated list of dashboard links based on various query parameters such as access control level, user ID, pagination settings, and sorting orders.

Common scenarios where this node is beneficial include:

  • Fetching customized dashboard links for specific users or roles.
  • Retrieving dashboard links with specific access levels for display or processing.
  • Paginating through large sets of dashboard links in an automated workflow.
  • Sorting dashboard links by multiple criteria.

For example, a user might use this node to get all dashboard links accessible to a particular user, sorted by creation date descending, and limited to 20 results per page.

Properties

Name Meaning
Access Control Level Filter dashboard links by their access control level.
Count Limit the number of dashboard links returned.
In App Filter dashboard links that are marked as "in app".
Order Primary field to sort the dashboard links by (string).
Order 2 Secondary field to sort the dashboard links by (string).
Order 3 Tertiary field to sort the dashboard links by (string).
Order 4 Fourth-level field to sort the dashboard links by (string).
Order 5 Fifth-level field to sort the dashboard links by (string).
Orderdesc Boolean or flag indicating descending order for the primary sort field.
Orderdesc 2 Descending order flag for the secondary sort field.
Orderdesc 3 Descending order flag for the tertiary sort field.
Orderdesc 4 Descending order flag for the fourth-level sort field.
Orderdesc 5 Descending order flag for the fifth-level sort field.
Page No The page number to retrieve (for pagination).
Page Size Number of dashboard links per page.
Pageinate Flag to enable or disable pagination.
Showall Flag to show all dashboard links without pagination limits.
Userid Filter dashboard links by a specific user ID.

Output

The node outputs JSON data containing the list of dashboard links retrieved from the Halo PSA API. Each item in the output corresponds to one dashboard link object as returned by the API.

The structure of each dashboard link object depends on the API response but typically includes properties such as link ID, name, URL, access control details, and metadata related to the dashboard link.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of base URL, tenant identifier, client ID, and client secret for the Halo PSA service.
  • Network connectivity to the Halo PSA API endpoint is necessary.

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API authentication credentials. Ensure that the required API key or authentication token is properly set up in n8n credentials.

  • Resource or Operation not found
    If the specified resource ("Dashboard Links") or operation ("List Of Dashboard Links") is not recognized, verify that the node parameters are correctly set and match the supported values.

  • API request failures
    Errors during the API call may be due to invalid query parameters, network issues, or API rate limits. Check the parameter values and ensure the Halo PSA API is reachable.

  • JSON parsing errors
    If using advanced JSON parameters, ensure that any JSON strings provided are valid and correctly formatted.

Links and References

Discussion