# List location

Returns a filtered and paginated list of locations within the current account context.
            
Behavior:
- Requires portfolio or space view/manage privileges
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves locations accessible to the current user
- Returns structured location list response data
- Logs the action as site list view

Endpoint: POST /api/v1/portfolio/locations/list

## Query parameters:

  - `start` (string)

## Request fields (application/json-patch+json):

  - `siteIds` (array,null)

  - `buildingIds` (array,null)

  - `levelIds` (array,null)

  - `roomId` (string,null)

  - `assetClassId` (string,null)

  - `assetTypeId` (string,null)

  - `assigned` (boolean)

  - `unassigned` (boolean)

  - `datafieldIds` (array,null)

  - `selectedIds` (array,null)

  - `status` (array,null)

  - `isEquipmentWithSpaceHandle` (boolean)

  - `includeFurniture` (boolean,null)

  - `levelName` (string,null)

  - `levelPosition` (integer)

  - `fieldValues` (array,null)

  - `fieldValues.dataFieldId` (string)

  - `fieldValues.dataFieldValue` (string,null)

  - `fieldValues.dataFieldlabel` (string,null)

  - `fieldValues.dataFieldValueIds` (array,null)

  - `fieldValues.fromDate` (string,null)

  - `fieldValues.toDate` (string,null)

  - `fieldValues.dataFieldValueRangeType` (string,null)

  - `isAdvancedSearch` (boolean,null)

  - `isLinkAsset` (boolean)

  - `assetClassIds` (array,null)

  - `assetTypeIds` (array,null)

  - `keyword` (string,null)

  - `sortColumn` (string,null)

  - `sortColumnId` (string,null)

  - `sortOrder` (string,null)

  - `filter` (string,null)

## Response 200 fields (text/plain):

  - `data` (object)

  - `data.generalProperties` (array,null)

  - `data.generalProperties.name` (string,null)

  - `data.generalProperties.alias` (string,null)

  - `data.generalProperties.dataType` (string,null)

  - `data.generalProperties.propertyType` (string,null)

  - `data.generalProperties.isKeyData` (boolean)

  - `data.generalProperties.visibility` (boolean)

  - `data.generalProperties.dataFieldId` (string)

  - `data.generalProperties.uiProperties` (object)

  - `data.generalProperties.uiProperties.fullWidth` (boolean)

  - `data.generalProperties.uiProperties.columnWidth` (string,null)

  - `data.generalProperties.uiProperties.columnSpan` (integer,null)

  - `data.data` (array,null)

  - `data.data.locationName` (string,null)

  - `data.data.locationId` (string)

  - `data.data.locationDescription` (string,null)

  - `data.data.address` (string,null)

  - `data.data.status` (object)

  - `data.data.status.statusId` (string)

  - `data.data.status.statusCode` (string,null)

  - `data.data.status.statusName` (string,null)

  - `data.data.status.statusColor` (string,null)

  - `data.data.additionalInfo` (array,null)

  - `data.data.additionalInfo.dataField` (string,null)

  - `data.data.additionalInfo.dataFieldId` (string)

  - `data.data.additionalInfo.dataIds` (array,null)

  - `data.data.additionalInfo.dataFieldValue` (any,null)

  - `data.data.additionalInfo.dataFieldName` (string,null)

  - `data.data.additionalInfo.dataValueFormated` (string,null)

  - `data.data.cadPlans` (array,null)

  - `data.data.cadPlans.planId` (string)

  - `data.data.cadPlans.planType` (object)

  - `data.data.cadPlans.planType.planTypeId` (string)

  - `data.data.cadPlans.planType.planTypeName` (string,null)

  - `data.data.cadPlans.planDescription` (string,null)

  - `data.data.cadPlans.planModel` (object)

  - `data.data.cadPlans.planModel.planModelId` (string)

  - `data.data.cadPlans.planModel.planModelName` (string,null)

  - `data.data.cadPlans.planFile` (object)

  - `data.data.cadPlans.planFile.fileId` (string)

  - `data.data.cadPlans.planFile.fileName` (string,null)

  - `data.data.cadPlans.planFile.fileSize` (string,null)

  - `data.data.cadPlans.planFile.currentRevisionNumber` (integer)

  - `data.data.cadPlans.planFile.createdOn` (string,null)

  - `data.data.cadPlans.planFile.fileSizeInBytes` (integer)

  - `data.data.cadPlans.planFile.createdDate` (string)

  - `data.data.cadPlans.planFile.createdBy` (string,null)

  - `data.data.cadPlans.planFile.isLatest` (boolean)

  - `data.data.cadPlans.revisions` (array,null)

  - `data.data.cadPlans.revisions.fileId` (string)

  - `data.data.cadPlans.revisions.fileName` (string,null)

  - `data.data.cadPlans.revisions.fileSize` (string,null)

  - `data.data.cadPlans.revisions.currentRevisionNumber` (integer)

  - `data.data.cadPlans.revisions.createdOn` (string,null)

  - `data.data.cadPlans.revisions.fileSizeInBytes` (integer)

  - `data.data.cadPlans.revisions.createdDate` (string)

  - `data.data.cadPlans.revisions.createdBy` (string,null)

  - `data.data.cadPlans.revisions.isLatest` (boolean)

  - `data.data.cadPlans.locationInfo` (object)

  - `data.data.cadPlans.locationInfo.location` (string,null)

  - `data.data.cadPlans.locationInfo.locationId` (string,null)

  - `data.data.cadPlans.locationInfo.building` (string,null)

  - `data.data.cadPlans.locationInfo.buildingId` (string,null)

  - `data.data.cadPlans.locationInfo.level` (string,null)

  - `data.data.cadPlans.locationInfo.levelId` (string,null)

  - `data.data.cadPlans.locationInfo.room` (string,null)

  - `data.data.cadPlans.locationInfo.roomId` (string,null)

  - `data.data.cadPlans.locationInfo.workspace` (string,null)

  - `data.data.cadPlans.locationInfo.workspaceId` (string,null)

  - `data.data.cadPlans.locationInfo.spaceKey` (string,null)

  - `data.data.cadPlans.locationInfo.spaceAssignedOn` (string,null)

  - `data.data.cadPlans.locationInfo.spaceCategory` (object)

  - `data.data.cadPlans.locationInfo.spaceCategory.spaceCategoryId` (string)

  - `data.data.cadPlans.locationInfo.spaceCategory.spaceCategoryName` (string,null)

  - `data.data.cadPlans.locationInfo.spaceCategory.spaceCategoryCode` (string,null)

  - `data.data.cadPlans.locationInfo.roomFunction` (object)

  - `data.data.cadPlans.locationInfo.roomFunction.roomFunctionId` (string)

  - `data.data.cadPlans.locationInfo.roomFunction.roomFunctionName` (string,null)

  - `data.data.cadPlans.locationInfo.spaceArea` (number,null)

  - `data.data.cadPlans.locationInfo.levelPlanHandle` (string,null)

  - `data.data.cadPlans.locationInfo.employeeLocationId` (string,null)

  - `data.data.cadPlans.locationInfo.rollBackInfo` (object)

  - `data.data.cadPlans.locationInfo.rollBackInfo.isRollBack` (boolean)

  - `data.data.cadPlans.locationInfo.rollBackInfo.rollBackType` (string,null)

  - `data.data.cadPlans.locationInfo.rollBackInfo.employeeLocationId` (string)

  - `data.data.cadPlans.locationInfo.rollBackInfo.comments` (string,null)

  - `data.data.cadPlans.locationInfo.levelPlanId` (string,null)

  - `data.data.cadPlans.locationInfo.planFile` (object)

  - `data.data.cadPlans.locationInfo.planFile.fileId` (string)

  - `data.data.cadPlans.locationInfo.planFile.fileName` (string,null)

  - `data.data.cadPlans.locationInfo.planFile.fileSize` (string,null)

  - `data.data.cadPlans.locationInfo.planFile.currentRevisionNumber` (integer)

  - `data.data.cadPlans.locationInfo.planFile.createdOn` (string,null)

  - `data.data.cadPlans.locationInfo.planFile.fileSizeInBytes` (integer)

  - `data.data.cadPlans.locationInfo.planFile.createdDate` (string)

  - `data.data.cadPlans.locationInfo.planFile.createdBy` (string,null)

  - `data.data.cadPlans.locationInfo.planFile.isLatest` (boolean)

  - `data.data.cadPlans.locationInfo.cadPlanCoordinates` (array,null)

  - `data.data.cadPlans.locationInfo.spaceAssignedOnDateTimeFormat` (string,null)

  - `data.data.cadPlans.locationInfo.svgPlanAdded` (boolean)

  - `data.data.cadPlans.assetIds` (array,null)

  - `data.data.cadPlans.svgPlanAdded` (boolean)

  - `data.data.cadPlans.responseDescription` (string,null)

  - `data.data.cadPlans.hasAnyRevisions` (boolean)

  - `data.data.cadPlans.isPlanRemoved` (boolean)

  - `data.data.cadPlans.responseMessage` (string,null)

  - `data.data.cadPlans.isCadPlanExist` (boolean)

  - `data.data.timeZone` (object)

  - `data.data.timeZone.timeZoneId` (integer)

  - `data.data.timeZone.timeZoneName` (string,null)

  - `data.data.timeZone.utcOffSet` (integer)

  - `data.data.noOfBuildings` (integer)

  - `data.data.noOfActiveBuildings` (integer)

  - `data.data.isCadPlanExist` (boolean)

  - `data.data.locationArea` (number,null)

  - `data.data.locationAreaText` (string,null)

  - `data.data.latitude` (number,null)

  - `data.data.longitude` (number,null)

  - `data.listProperties` (object)

  - `data.listProperties.totalCount` (integer)

  - `data.listProperties.currentStart` (integer)

  - `data.listProperties.currentLength` (integer)

  - `data.listProperties.pageCount` (integer)

  - `message` (string,null)

  - `isError` (boolean)

  - `messageCode` (integer)

  - `status` (string,null)

  - `errorType` (string,null)

  - `traceid` (string,null)

  - `responseDescription` (string,null)