---
title: "Installation hierarchy"
method: GET
path: "/api/installation/{id}/hierarchy"
tags: ["Installation"]
---

# Installation hierarchy

`GET /api/installation/{id}/hierarchy`

Retrieves an installation along with its circuit and charger hierarchy  
(requires owner or service permissions).

<b>Note:</b> Only basic properties of the returned model will be populated.

## Path parameters

- `id` string, uuid, required

## Response `200`

OK

- InstallationTreeModel
  - `id` string, uuid — Get the unique identifier of the installation.
  - `name` string, nullable — Get the installation name.
  - `installationName` string, nullable — <strong>This property is obsolete and is scheduled for removal,</strong> please use `InstallationName` instead.
  - `networkType` integer, nullable — Get the installation electrical grid type Id. Please refer to the Zaptec integration document for information for explanation of grid type Id.
  - `circuits` InstallationTreeCircuitModel[], nullable — Get a list of circuits managed by the installation.
    - `id` string, uuid — Get the unique identifier of the circuit.
    - `name` string, nullable — Get the circuit name.
    - `maxCurrent` number, double — Get the circuit max current (fuse rating).
    - `isActive` boolean — Get a value indicating whether the circuit is active.
    - `active` boolean — <strong>This property is obsolete and is scheduled for removal,</strong> please use `IsActive` instead.
    - `installationId` string, uuid — Get the unique identifier of the circuits parent installation.
    - `installationName` string, nullable — Get the name of the circuits parent installation.
    - `chargers` InstallationTreeChargerModel[], nullable — Get a list of charger installed in the circuit.
      - `id` string, uuid — Get the unique identifier of the charge point.
      - `deviceId` string, nullable — Get the deviceId (serialNo) of the charging stations used with the charge point.
      - `mid` string, nullable — <strong>This property is obsolete and is scheduled for removal,</strong> please use `DeviceId` instead.
      - `name` string, nullable — Get the name of the charge point.
      - `serialNo` string, nullable — <strong>This property is obsolete and is scheduled for removal,</strong> please use `Name` instead.
      - `active` boolean, nullable — Get a value indicating whether the charge point is active.
      - `deviceType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — 0 = Unknown 1 = Smart 2 = Portable 3 = HomeApm 4 = Apollo 5 = OtherApm 6 = GenericApm 7 = HanApm 8 = TicApm
  - `countryId` string, uuid — Get the unique identified of the country. Ignored for the public contract

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.dev/zaptec/apis/zaptec-api.md) · [All operations](https://skmtc.dev/zaptec/apis/zaptec-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zaptec/zaptec-api/revisions/6892fe4b8df5/schema)
