Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Users → List Of Users

AI-generated

Overview

This node integrates with the Halo PSA API to list users based on various filtering and sorting criteria. It is designed to retrieve user data from a Halo PSA system, allowing you to query users by attributes such as activity status, department, client, site, role, and more. This node is useful in scenarios where you need to automate workflows involving user management, reporting, or synchronization with other systems.

Practical examples:

  • Fetch all active users belonging to a specific department for generating reports.
  • Retrieve only users who are approvers to trigger approval-related workflows.
  • List users assigned to a particular asset or client for asset management automation.
  • Paginate through large user lists to process them in batches.

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 queries to filter users.
Allapprovers Boolean to add an OR condition to include all users that are approvers.
Approvers Only Boolean to include only users who are approvers.
Asset Id Integer to filter users assigned to a particular asset.
Client Id Integer to filter users belonging to a particular 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 particular 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 belonging to an integration; possible values: 'okta', 'azure'.
Is Followers Boolean filter related to followers (exact meaning depends on API context).
Is 3 Cxcall Boolean filter related to 3CX call integration (exact meaning depends on API context).
Lastupdatefromdate Boolean to include the field last update from date in the response.
Lastupdatetodate Boolean to include the field last update to date in the response.
Licence Id Integer filter by license ID.
Listagentuserfirst Boolean to order users who are also agents first in the response.
Myallcustomers Boolean filter related to "my all customers" (context-specific).
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 name to order by.
Order 2 String specifying the second field name to order by.
Order 3 String specifying the third field name to order by.
Order 4 String specifying the fourth field name to order by.
Order 5 String specifying the fifth field name 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 in the response.
Role Filter users by role.
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 an array of JSON objects representing the users retrieved from the Halo PSA API according to the applied filters and parameters. Each item corresponds to one input item processed and contains the full JSON response from the API under the json property.

If the "Idonly" option is used, the output will contain only user IDs instead of full user details.

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 via credentials.
  • Uses HTTP requests to communicate with the Halo PSA REST API endpoints.

Troubleshooting

  • No credentials returned!: Ensure that the required API authentication credentials are properly configured in n8n.
  • Resource or Operation not found: Verify that the selected resource is "Users" and operation is "List Of Users".
  • Invalid parameter values: Check that integer fields receive valid integers and boolean fields are set correctly.
  • Pagination issues: When using "Idonly", pagination is not supported; disable pagination or avoid using "Idonly".
  • API errors: If the API returns errors, check network connectivity, API limits, and correct usage of filters.

Links and References

Discussion