Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Company → List Of Company

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Company resource and the List Of Company operation, it retrieves a list of companies from the Halo PSA system based on provided query parameters such as filtering by active status, pagination, ordering, and search criteria.

Typical use cases include:

  • Fetching a filtered list of companies for reporting or synchronization.
  • Automating workflows that require company data from Halo PSA.
  • Integrating company data into other systems or dashboards.

For example, you might use this node to get all active companies sorted by name or to paginate through large sets of company records.

Properties

Name Meaning
Activeinactive Filter companies by their active/inactive status.
Count Limit the number of companies returned in the response.
Idonly Return only the IDs of the companies instead of full details.
Includeactive Include active companies in the results.
Includeinactive Include inactive companies in the results.
Kashflowtenantid Tenant ID specific to Kashflow integration (used as a filter).
Order Primary field to order the results by.
Order 2 Secondary field to order the results by.
Order 3 Tertiary field to order the results by.
Order 4 Fourth-level field to order the results by.
Order 5 Fifth-level field to order the results by.
Orderdesc Boolean or flag indicating descending order for the primary order field.
Orderdesc 2 Descending order flag for the secondary order field.
Orderdesc 3 Descending order flag for the tertiary order field.
Orderdesc 4 Descending order flag for the fourth-level order field.
Orderdesc 5 Descending order flag for the fifth-level order field.
Page No The page number to retrieve when paginating results.
Page Size Number of companies per page in paginated results.
Pageinate Flag to enable or disable pagination.
Search Search term to filter companies by matching text fields.
Toplevel Id Filter companies by a top-level identifier.
Xerotenantid Tenant ID specific to Xero integration (used as a filter).

Output

The output is an array of JSON objects representing the companies retrieved from the Halo PSA API according to the specified filters and pagination. Each item corresponds to one company record with its associated fields as returned by the API.

If the Idonly property is set, the output will contain only company IDs rather than full company details.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant ID, client ID, and client secret.
  • The node uses these credentials to authenticate 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 find or access the required API credentials. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Company") and operation ("List Of Company") names are used.

  • API request errors
    Errors from the Halo PSA API (e.g., authentication failure, invalid parameters) will be returned in the output JSON under an error field if "Continue On Fail" is enabled. Otherwise, they will cause the node to fail. Check your credentials and input parameters.

  • Pagination issues
    Incorrect values for Page No, Page Size, or Pageinate may result in unexpected or empty results. Verify these parameters for correctness.

Links and References

Discussion