UnitGroup

A unit group represents a collection of units within an organization.

type UnitGroup {
  businessUnit: BusinessUnit
  customReference: String
  externalReference: String
  icon: String
  id: UUID
  name: String
  organization: Organization
  path: String
}

Fields

Nom	Type	Description
businessUnit	BusinessUnit object	The business unit to which this unit group belongs
customReference	String scalar	A custom reference for the unit group
externalReference	String scalar	The external reference of the unit group
icon	String scalar	The icon associated with the unit group
id	UUID scalar	—
name	String scalar	The name of the unit group
organization	Organization object	The organization to which this unit group belongs
path	String scalar	The hierarchical path of the unit group addUnitGroupToUnitGroup addUnitToUnitGroup createChildUnitGroup createEmptyUnitGroup deleteUnitGroup listUnitGroups modifyUnitGroup removeUnitFromUnitGroup unitGroup unitGroupsByParentName ApartmentUnit HouseUnit OtherUnit ParkingUnit Unit UnitV2