Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Site → Get One Site

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific site. The "Get One Site" operation fetches data for a single site identified by its unique ID, optionally filtered or expanded with additional query parameters.

Typical use cases include:

  • Fetching site details for reporting or auditing purposes.
  • Integrating site information into workflows that require up-to-date site data.
  • Retrieving site ticket activity or extra related details to enrich downstream processes.

For example, you might use this node to get all relevant information about a client’s site before creating a service ticket or generating a status report.

Properties

Name Meaning
Id The unique identifier (number) of the site to retrieve. This is required.
Client Override (int) Optional filter to specify a client ID to override the default client context.
Domain (string) Filter on site permissions; e.g., 'opps' defaults to sites opportunities.
Includeactivity (bool) Whether to include site ticket activity in the response.
Includedetails (bool) Whether to include extra objects/details in the response.
Issetup (bool) Optional flag, purpose not explicitly described but sent as a query parameter.
Tickettype Id (int) Optional filter specifying a ticket type ID to refine the returned data.

Output

The node outputs JSON data representing the retrieved site object from the Halo PSA API. The structure corresponds to the API's site resource schema and may include:

  • Basic site information such as name, address, and identifiers.
  • Optionally included ticket activity if Includeactivity is true.
  • Additional related details if Includedetails is set.
  • Filters applied based on client, domain, setup status, or ticket type.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials including base URL, tenant identifier, client ID, and client secret configured in n8n.
  • The node uses HTTP requests with appropriate headers for authentication.
  • No other external dependencies are required.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node will throw an error indicating missing credentials. Ensure the API key credential is properly configured.
  • Resource or Operation Not Found: Errors occur if the specified resource or operation does not exist. Verify that "Site" and "Get One Site" are correctly selected.
  • Invalid Site ID: Providing an incorrect or non-existent site ID may result in API errors or empty responses. Confirm the ID is valid.
  • API Request Failures: Network issues or incorrect API endpoint configuration can cause request failures. Check connectivity and credential settings.
  • JSON Parsing Issues: If additional fields or query parameters are provided as JSON strings, ensure they are well-formed to avoid parsing errors.

Using the "Continue On Fail" option can help handle errors gracefully within workflows.

Links and References

Discussion