HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions290

Top Level → Get by ID

AI-generated

Summary

Retrieve a Top Level record in HaloPSA by its unique ID.

Inputs

  • Top Level ID (required) — The unique numeric identifier of the Top Level entity to retrieve.
  • Include Details — Optional boolean to include additional detailed information in the response.
  • Include Agents — Optional boolean to include agents associated with the Top Level in the response.
  • Include Teams — Optional boolean to include teams associated with the Top Level in the response.

Output shape

A single Top Level record object as returned by the HaloPSA API, potentially including nested details, agents, and teams depending on options selected.

The returned data shape varies depending on boolean flags 'Include Details', 'Include Agents', and 'Include Teams'. The record includes these nested objects only if respective flags are true.

Examples

Example 1: Get details of a specific Top Level by ID including its agents and teams

Set 'Top Level ID' to the entity's ID, and enable 'Include Agents' and 'Include Teams'. Leave 'Include Details' disabled if not needed.

Links

Discussion