Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Users → Get One Users

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a single user based on specified criteria. It is particularly useful in scenarios where you need to fetch user data enriched with optional related details such as billing info, activity logs, assets, or site-specific permissions. For example, it can be used to automate workflows that require user profile verification, auditing user activities, or syncing user data with other systems.

Properties

Name Meaning
Id The unique identifier of the user to retrieve (required).
Client Id Filter users by a specific client ID (integer).
Client Override Overrides the client filter with a custom value.
Domain Filter users by domain or site permissions; defaults to 'opps' for opportunities.
Includeactivity Whether to include site ticket activity in the response (boolean).
Includebillinginfo Include billing information in the response (boolean).
Includedetails Include extra related objects/details in the response (boolean).
Includepopups Whether to include customer pop-ups in the response (boolean).
Includeusersassets Include user assets in the response (boolean).
Issetup A flag parameter, purpose unspecified (boolean).
Opp Id Filter users assigned to a particular opportunity ID (integer).
Site Id Filter users by a specific site ID (integer).
Site Override Overrides the site filter with a custom value.
Supplier Id Filter users by a specific supplier ID (integer).
Tickettype Id Filter users by a specific ticket type ID.
Username Filter users by username (string).

Output

The node outputs JSON data representing the user information retrieved from the Halo PSA API. This includes the user's core details and any additional related data requested via the input properties (such as billing info, activity, assets, etc.). The output is structured as an array of items, each containing a json field with the user data. There is no binary data output.

Example output structure:

{
  "id": 123,
  "username": "jdoe",
  "email": "jdoe@example.com",
  "billingInfo": { ... },
  "activity": [ ... ],
  "assets": [ ... ],
  ...
}

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

Troubleshooting

  • No credentials returned!: Ensure that the API authentication credentials are properly configured in n8n.
  • Resource or Operation not found: Verify that the selected resource is "Users" and operation is "Get One Users".
  • Invalid or missing required parameters: The Id property is mandatory; ensure it is provided and valid.
  • API request failures: Network issues, incorrect credentials, or invalid query parameters may cause errors. Check the error message for details.
  • If the node is set to continue on failure, errors will be included in the output JSON under an error field.

Links and References

Discussion