Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Lookup → List Of Lookup

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Lookup resource and the List Of Lookup operation, it retrieves a list of lookup entries filtered by multiple optional query parameters. This is useful when you want to fetch categorized or reference data from Halo PSA, such as asset types, client information, contract details, or other metadata that can be used in workflows for decision-making, reporting, or further processing.

Practical examples include:

  • Fetching all asset types available in your Halo PSA instance.
  • Retrieving client names or IDs based on specific criteria.
  • Listing contract or ticket-related lookup values to enrich workflow data.

Properties

Name Meaning
Access Control Level Filter lookups by access control level.
Assettype Id Filter lookups by asset type identifier.
Client Id Filter lookups by client identifier.
Clientname Filter lookups by client name (string).
Contract Id Filter lookups by contract identifier.
Country Code Id Filter lookups by country code identifier.
Dbc Company Id Filter lookups by DBC company identifier (string).
Domain Filter lookups by domain (string).
Exclude Nocharge Exclude lookups marked as no charge.
Exclude Nolinkedtypes Exclude lookups without linked types.
Exclude Zero Exclude lookups with zero value.
Iscustomfield Filter lookups that are custom fields.
Istree Filter lookups that are tree structures.
Lookupid Filter by specific lookup identifier.
Ordervaluetype Filter lookups by order value type.
Outcome Id Filter lookups by outcome identifier.
Showallcodes Option to show all codes in the lookup.
Ticket Id Filter lookups by ticket identifier.
Unameaprestriction Filter lookups by username API restriction.
Use Filter lookups by usage type.
Use 2 Additional filter for usage type.

All these properties are sent as query parameters to the API request, allowing fine-grained filtering of the lookup list.

Output

The node outputs an array of JSON objects representing the lookup entries returned by the Halo PSA API. Each item corresponds to one lookup record matching the specified filters.

The output structure under the json field contains the raw response data from the API, which typically includes fields relevant to each lookup entry such as IDs, names, codes, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials including base URL, tenant identifier, client ID, and client secret for authentication.
  • The node uses HTTP requests with appropriate headers to communicate with the Halo PSA API.
  • No additional external services or environment variables are required beyond the configured API credentials.

Troubleshooting

  • No credentials returned!: Ensure that the API credentials are properly configured and valid in n8n.
  • Resource or Operation not found: Verify that the selected resource is "Lookup" and operation is "List Of Lookup". These must match exactly.
  • API request errors: Could be due to invalid query parameters or network issues. Check parameter values and connectivity.
  • JSON parsing errors: If using advanced JSON parameters, ensure they are correctly formatted.
  • To handle errors gracefully, enable "Continue On Fail" in the node settings to prevent workflow interruption.

Links and References

If you need more detailed information about other resources or operations, feel free to ask!

Discussion