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 interacts with the HaloPSA API to retrieve detailed information about an agent by their unique ID. It is useful in scenarios where you need to fetch specific agent data for further processing, reporting, or integration within workflows. For example, you might use this node to get an agent’s profile details before assigning tickets or generating performance reports.
Properties
| Name | Meaning |
|---|---|
| Agent ID | The unique numeric identifier of the agent to retrieve. |
| Additional Options | A collection of optional parameters to customize the request: |
| - Client ID Override | Override the client ID used for filtering the agent data. |
| - Get Holiday Allowance | Boolean flag to include holiday allowance information in the response. |
| - Get HTML Designer Signature | Boolean flag to include the HTML designer signature of the agent. |
| - Include Details | Boolean flag to include extra related objects/details in the response. |
| - Is Agent Config | Boolean flag indicating if the request is for agent configuration data. |
| - Load Cache | Boolean flag to specify whether to load cached data instead of fresh data from the API. |
Output
The node outputs JSON data representing the agent's information as returned by the HaloPSA API. This includes the agent’s core attributes and, depending on the additional options selected, may also include holiday allowance, HTML signatures, and other detailed related objects. The output does not include binary data.
Dependencies
- Requires a valid API key credential for authenticating requests to the HaloPSA API.
- The node depends on the external HaloPSA service being accessible.
- No additional environment variables are explicitly required beyond the API authentication setup.
Troubleshooting
Common Issues:
- Invalid or missing Agent ID will cause the API call to fail or return no data.
- Incorrect API credentials or expired tokens will result in authentication errors.
- Selecting incompatible or unsupported additional options may lead to incomplete or unexpected responses.
Error Messages:
- Authentication failures typically indicate issues with the provided API key; verify and update credentials.
- "Agent not found" errors suggest the specified Agent ID does not exist; confirm the ID is correct.
- Network or timeout errors imply connectivity problems with the HaloPSA API endpoint; check network access.
Links and References
- HaloPSA API Documentation (for detailed API endpoints and parameters)
- n8n Documentation on Creating Custom Nodes