Get all units with their details
Query Parameters
AmenityCategoryCode to be passed to filter the response of the amenityCategories
List of constant strings to return only the selected sections in the response. The possible values are ADDRESS, AMENITYCATEGORYSETS, CAPACITIES, CAPACITYREQUIREMENTS, DYNAMICFIELDS, IMAGES, ROOMS, VIDEOS, TRANSLATIONS, DOORLOCKTYPES. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.
ADDRESSAMENITYCATEGORYSETSCAPACITIESCAPACITYREQUIREMENTSDYNAMICFIELDSIMAGESROOMSTRANSLATIONSVIDEOSDOORLOCKTYPESWork order type units are not returned by default. To get work order type units, this request parameter can be used
List of unitIds to fetch the details
Page number
Size of the current page
Sort parameter
Following fields can be used for filtering response.
unitId:0,
type:String,
resourceId:0,
code:String,
nrOfBathrooms:0.0,
path:String,
excludeQuestionnaireStats:true,
choosableOnInternet:true,
resourceGroupId:0,
cleaningStatus:String,
roomCode:String,
nrOfBedrooms:0,
archivedFrom:2026-04-02,
vsi:0,
origin:String,
originId:String,
energyLabelRegistrationNumber:String,
previousPmsId:String,
rentableUnitId:0,
...
Response
Response Attributes
Total number of elements available in the whole response.
Total number of pages the response has.
Size of the current page.
Show child attributes
Page number currently accessed.
Show child attributes
Boolean field to specify if its the first page or not.
Boolean field to specify if its the last page or not.
Total number of elements in the current page.
Response