Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Email Address Book → List Of Users

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of users from an Email Address Book resource. It allows filtering and sorting of users based on various criteria such as activity status, roles, departments, sites, and more. This node is useful for scenarios where you need to programmatically access user information from your organization's address book, for example:

  • Synchronizing user lists with other systems.
  • Generating reports on active or inactive users.
  • Filtering users by department, site, or role for targeted communications.
  • Retrieving approvers or service accounts for workflow automation.

Properties

Name Meaning
Activeinactive Takes two comma separated values; first sets inclusion of active users, second sets inclusion of inactive users.
Advanced Search A string for advanced search filtering.
Allapprovers Boolean to add an OR condition to include all users who are approvers.
Approvers Only Boolean to include only users that are approvers.
Asset Id Integer to filter users assigned to a particular asset.
Client Id Integer to filter users belonging to a specific client.
Contract Id Integer to filter users assigned to a particular device application type.
Count Integer specifying number of results to return when not using pagination.
Department Id Integer to filter users belonging to a specific department.
Exclude Agents Boolean to exclude users who are also agents.
Exclude Defaultsiteusers Boolean to exclude default site users.
Exclude Generaluser Boolean to exclude general users.
Idonly Boolean to return only the User ID field (not compatible with pagination).
Includeactive Boolean to include active users in the response.
Includebillinginfo Boolean to include billing information in the response.
Includeinactive Boolean to include inactive users in the response.
Includename Boolean to include user names.
Includenonserviceaccount Boolean to include non-service account users.
Includenotes Boolean to include user notes.
Includeserviceaccount Boolean to include service account users.
Integration Type String to filter users by integration type; possible values: 'okta', 'azure'.
Is Followers Boolean flag (purpose unspecified).
Is 3 Cxcall Boolean flag (purpose unspecified).
Lastupdatefromdate Boolean to include the field lastupdatefromdate in the response.
Lastupdatetodate Boolean to include the field lastupdatetodate in the response.
Licence Id Integer filter by license ID.
Listagentuserfirst Boolean to order users who are agents first in the response.
Myallcustomers Boolean flag (purpose unspecified).
Myarea Boolean to include only users belonging to your area.
Mydepartment Boolean to include only users belonging to your department.
Mysite Boolean to include only users belonging to your site.
Mysitecontact Boolean to include only users belonging to your site contact.
Mytoplevel Boolean to include only users belonging to your top level.
Opp Id Integer to filter users assigned to a particular opportunity.
Order String specifying the first field to order by.
Order 2 String specifying the second field to order by.
Order 3 String specifying the third field to order by.
Order 4 String specifying the fourth field to order by.
Order 5 String specifying the fifth field to order by.
Orderdesc Boolean indicating ascending (false) or descending (true) order for the first order field.
Orderdesc 2 Boolean indicating ascending/descending order for the second order field.
Orderdesc 3 Boolean indicating ascending/descending order for the third order field.
Orderdesc 4 Boolean indicating ascending/descending order for the fourth order field.
Orderdesc 5 Boolean indicating ascending/descending order for the fifth order field.
Organisation Id Integer to filter users belonging to a particular organisation.
Page No Integer page number to return when using pagination.
Page Size Integer size of the page when using pagination.
Pageinate Boolean to enable or disable pagination.
Role Filter users by role (type unspecified).
Search String to filter users matching the search string.
Search Phonenumbers Boolean to filter users with phone numbers matching the search.
Site Id Integer to filter users belonging to a particular site.
Supplier Id Integer to filter users belonging to a specified supplier.
Tickettype Id Integer filter by ticket type ID.
Toplevel Id Integer to filter users belonging to a particular top level.

Output

The node outputs JSON data containing the list of users retrieved from the Email Address Book according to the applied filters and parameters. Each item in the output corresponds to one input item processed and contains the full response from the API call under the json property.

  • The structure of each user object depends on the API response but typically includes user details such as IDs, names, roles, status, contact info, and optionally billing info, notes, and other metadata depending on the input parameters.
  • If the idonly option is used, the output will contain only user IDs.
  • Pagination parameters control how many users and which page of results are returned.
  • The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • Needs configuration of base URL, tenant, client ID, and client secret credentials for the Halo PSA API.
  • Uses HTTP requests to communicate with the Halo PSA REST endpoints.
  • No additional external dependencies beyond those bundled with n8n and the included openapi client.

Troubleshooting

  • No credentials returned!: Ensure that the required API authentication credentials are properly configured and connected in n8n.
  • Resource or Operation not found: Verify that the selected Resource is "Email Address Book" and Operation is "List Of Users". These must match exactly.
  • Invalid parameter values: Some parameters expect integers or booleans; ensure correct types are provided.
  • Pagination issues: Using idonly is incompatible with pagination; avoid combining these options.
  • API errors: Network issues or invalid credentials can cause request failures. Check API keys and network connectivity.
  • When continueOnFail is enabled, errors for individual items will be returned in the output JSON under an error property instead of stopping execution.

Links and References

Discussion