Actions68
- Client Actions
- Agent Actions
- Asset Actions
- Field Info Actions
- Invoice Actions
- Site Actions
- Ticket Actions
- Ticket Status Actions
- Ticket Type Actions
- Timesheet Actions
- Timesheet Event Actions
- Webhook Actions
- Webhook Event Actions
Overview
This node integrates with the HaloPSA API to retrieve detailed information about clients. Specifically, the "Client - Get by ID" operation fetches a single client's data based on their unique client ID. It supports optional parameters to include additional related data such as ticket types the client can log, customer ticket activity, pre-pay periods, and more.
This node is beneficial in scenarios where you need to:
- Retrieve comprehensive client details for reporting or automation.
- Enrich workflows with client-specific ticketing or billing information.
- Filter client data based on permissions or ticket types.
Example use case:
An IT service management workflow that automatically pulls client details and their active tickets to generate status reports or trigger notifications.
Properties
| Name | Meaning |
|---|---|
| Client ID | The unique numeric identifier of the client to retrieve. |
| Additional Fields | Optional fields to customize the response: |
| - Domain | Filter on client permissions; defaults to "opps" (client opportunities) if not specified. |
| - Get Available RTs | Boolean flag to include a list of ticket types the client can log. |
| - Include Activity | Boolean flag to include customer ticket activity in the response. |
| - Include Details | Boolean flag to include extra objects/details in the response. |
| - Include Periods | Boolean flag to include pre-pay periods in the response. |
| - Include Prepay | Boolean flag to include pre-pay information in the response. |
| - Ticket Type ID | Numeric filter to specify a particular ticket type ID. |
Output
The node outputs JSON data representing the client object retrieved from the HaloPSA API. This includes the client's core details and any additional data requested via the optional fields, such as ticket types, activities, or pre-pay information.
If binary data were involved (not indicated here), it would typically represent files or attachments related to the client, but this node focuses on JSON data only.
Dependencies
- Requires an API key credential for authenticating with the HaloPSA API.
- The node depends on the HaloPSA API being accessible and properly configured.
- No other external dependencies are required beyond standard HTTP requests to the API.
Troubleshooting
Common issues:
- Invalid or missing Client ID will result in errors or empty responses.
- Insufficient API permissions may cause authorization failures.
- Network connectivity problems can prevent successful API calls.
Error messages:
- "Client not found" — Verify the Client ID is correct and exists in HaloPSA.
- "Unauthorized" or "Authentication failed" — Check that the API key credential is valid and has necessary permissions.
- Timeout or network errors — Ensure the API endpoint is reachable and your network allows outbound connections.
Resolving these usually involves verifying input parameters, credentials, and network settings.
Links and References
- HaloPSA API Documentation (for detailed API endpoints and parameters)
- n8n documentation on creating custom nodes