HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions290

Site → Get by ID

AI-generated

Summary

Retrieve detailed information about a specific Site using its ID, with optional filters and the ability to include additional related data.

Inputs

  • Site ID (required) — The ID of the site to retrieve.
  • Client Override — Filter results by a specific client ID.
  • Domain — Filter on site permissions; 'opps' defaults to sites with opportunities.
  • Include Activity — Whether to include ticket activity related to the site in the response.
  • Include Details — Whether to include extra site-related objects such as contacts, delivery address, full client details with custom fields and billing plans, additional fields, popup notes, external links, extra tabs, FAQ lists, and country/region details.
  • Is Setup — Whether to include setup-related information in the response.
  • Ticket Type ID — Filter by a specific ticket type ID.

Output shape

A detailed object representing the Site, including optionally related entities and activity depending on provided filters and options.

The returned object can include extra details such as site contacts, delivery address, client details, tickets activity, and other related data when corresponding options are enabled. The Site ID input is mandatory, and other options are optional filters affecting the response content.

Links

Discussion