# List employees

Returns a filtered and/or paginated list of employees within the current account context.
            
Behavior:
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves employees associated with the account
- Returns summarised employee view details
- Logs the action as an employee list view event

Endpoint: POST /api/v1/portfolio/employees/all

## Query parameters:

  - `start` (string)

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

  - `assigned` (boolean)

  - `unassigned` (boolean)

  - `levelId` (string,null)

  - `buildingId` (string,null)

  - `locationId` (string,null)

  - `employeeId` (string,null)

  - `roomId` (string,null)

  - `datafieldIds` (array,null)

  - `selectedIds` (array,null)

  - `siteIds` (array,null)

  - `buildingIds` (array,null)

  - `levelIds` (array,null)

  - `isEmployeeWithSpaceHandle` (boolean)

  - `status` (array,null)

  - `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)

  - `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.employeeDesignation` (object)

  - `data.data.employeeDesignation.employeeDesignationId` (string)

  - `data.data.employeeDesignation.employeeDesignationName` (string,null)

  - `data.data.organizationUnit` (object)

  - `data.data.organizationUnit.orgUnitLevel1` (object)

  - `data.data.organizationUnit.orgUnitLevel1.levelName` (string,null)

  - `data.data.organizationUnit.orgUnitLevel1.unitIdentifier` (string)

  - `data.data.organizationUnit.orgUnitLevel1.unitName` (string,null)

  - `data.data.organizationUnit.orgUnitLevel2` (object)

  - `data.data.organizationUnit.orgUnitLevel2.levelName` (string,null)

  - `data.data.organizationUnit.orgUnitLevel2.unitIdentifier` (string)

  - `data.data.organizationUnit.orgUnitLevel2.unitName` (string,null)

  - `data.data.organizationUnit.orgUnitLevel3` (object)

  - `data.data.organizationUnit.orgUnitLevel3.levelName` (string,null)

  - `data.data.organizationUnit.orgUnitLevel3.unitIdentifier` (string)

  - `data.data.organizationUnit.orgUnitLevel3.unitName` (string,null)

  - `data.data.organizationUnit.orgUnitLevel4` (object)

  - `data.data.organizationUnit.orgUnitLevel4.levelName` (string,null)

  - `data.data.organizationUnit.orgUnitLevel4.unitIdentifier` (string)

  - `data.data.organizationUnit.orgUnitLevel4.unitName` (string,null)

  - `data.data.organizationUnit.orgUnitLevel5` (object)

  - `data.data.organizationUnit.orgUnitLevel5.levelName` (string,null)

  - `data.data.organizationUnit.orgUnitLevel5.unitIdentifier` (string)

  - `data.data.organizationUnit.orgUnitLevel5.unitName` (string,null)

  - `data.data.organizationUnit.orgUnits` (object)

  - `data.data.organizationUnit.orgUnits.primaryUnits` (string,null)

  - `data.data.organizationUnit.orgUnits.secondaryUnits` (string,null)

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

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

  - `data.data.gender` (object)

  - `data.data.gender.genderId` (string)

  - `data.data.gender.genderName` (string,null)

  - `data.data.gender.genderCode` (string,null)

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

  - `data.data.supervisor` (object)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `data.data.supervisor.employmentType` (object)

  - `data.data.supervisor.employmentType.employmentTypeId` (string)

  - `data.data.supervisor.employmentType.employmentTypeName` (string,null)

  - `data.data.supervisor.employmentType.employmentTypeCode` (string,null)

  - `data.data.supervisor.employeeCategory` (object)

  - `data.data.supervisor.employeeCategory.employeeCategoryId` (string)

  - `data.data.supervisor.employeeCategory.employeeCategoryName` (string,null)

  - `data.data.supervisor.employeeCategory.employeeCategoryDescription` (string,null)

  - `data.data.supervisor.employeeCategory.isLaborCategory` (boolean)

  - `data.data.supervisor.employeeCategory.responseDescription` (string,null)

  - `data.data.supervisor.supervisor` (object)

  - `data.data.supervisor.status` (object)

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

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

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

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

  - `data.data.supervisor.employeeWorkMode` (object)

  - `data.data.supervisor.employeeWorkMode.employeeWorkModeId` (string)

  - `data.data.supervisor.employeeWorkMode.employeeWorkModeName` (string,null)

  - `data.data.supervisor.employeeWorkMode.employeeWorkModeCode` (string,null)

  - `data.data.supervisor.serviceEndDate` (object)

  - `data.data.supervisor.serviceEndDate.serviceEndDate` (string,null)

  - `data.data.supervisor.serviceEndDate.status` (object)

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

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

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

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

  - `data.data.supervisor.employeeId` (string)

  - `data.data.supervisor.employeeName` (string,null)

  - `data.data.supervisor.employeeFirstName` (string,null)

  - `data.data.supervisor.employeeMiddleName` (string,null)

  - `data.data.supervisor.employeeLastName` (string,null)

  - `data.data.supervisor.email` (string,null)

  - `data.data.supervisor.employeeCode` (string,null)

  - `data.data.supervisor.employeeRole` (string,null)

  - `data.data.supervisor.profilePic` (string,null)

  - `data.data.supervisor.dateOfTermination` (string,null)

  - `data.data.supervisor.dateOfJoining` (string,null)

  - `data.data.supervisor.employeeUserId` (string,null)

  - `data.data.supervisor.isTechnician` (boolean)

  - `data.data.supervisor.isCreateUserAccount` (boolean)

  - `data.data.supervisor.userRoles` (array,null)

  - `data.data.supervisor.userRoles.accountAccessGroupId` (string)

  - `data.data.supervisor.userRoles.accountAccessGroupName` (string,null)

  - `data.data.supervisor.isSupervisor` (boolean)

  - `data.data.supervisor.isRollBackAllowed` (boolean)

  - `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.location` (string,null)

  - `data.data.employeeGrade` (object)

  - `data.data.employeeGrade.employeeGradeId` (string)

  - `data.data.employeeGrade.employeeGradeName` (string,null)

  - `data.data.employeeGrade.rank` (integer)

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

  - `data.data.locationInfo` (object)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `data.data.employmentType` (object)

  - `data.data.employmentType.employmentTypeId` (string)

  - `data.data.employmentType.employmentTypeName` (string,null)

  - `data.data.employmentType.employmentTypeCode` (string,null)

  - `data.data.employeeCategory` (object)

  - `data.data.employeeCategory.employeeCategoryId` (string)

  - `data.data.employeeCategory.employeeCategoryName` (string,null)

  - `data.data.employeeCategory.employeeCategoryDescription` (string,null)

  - `data.data.employeeCategory.isLaborCategory` (boolean)

  - `data.data.employeeCategory.responseDescription` (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.employeeWorkMode` (object)

  - `data.data.employeeWorkMode.employeeWorkModeId` (string)

  - `data.data.employeeWorkMode.employeeWorkModeName` (string,null)

  - `data.data.employeeWorkMode.employeeWorkModeCode` (string,null)

  - `data.data.serviceEndDate` (object)

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

  - `data.data.serviceEndDate.status` (object)

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

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

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

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

  - `data.data.employeeId` (string)

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

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

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

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

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

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

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

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

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

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

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

  - `data.data.isTechnician` (boolean)

  - `data.data.isCreateUserAccount` (boolean)

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

  - `data.data.userRoles.accountAccessGroupId` (string)

  - `data.data.userRoles.accountAccessGroupName` (string,null)

  - `data.data.isSupervisor` (boolean)

  - `data.data.isRollBackAllowed` (boolean)

  - `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)