# zOne Web Services

The zOne Web Services API enables integration with core platform capabilities,including Maintenance Management, Space Management, and Condition Assessment.

It provides secure endpoints for managing assets, user accounts, reference data, audit trails, file groups, and organizational contacts. These APIs support operational workflows, data synchronization, and system integrations.


## Servers

Demo
```
https://demozone.zlinkfm.com/RND
```

## Download OpenAPI description

[zOne Web Services](https://zonedevelopersdocumentationv1.redocly.app/_bundle/apis/index.yaml)

## Account Management

### Get current user profile

 - [GET /api/v1/account/users/me](https://zonedevelopersdocumentationv1.redocly.app/apis/account-management/paths/~1api~1v1~1account~1users~1me/get.md): This endpoint returns the account and profile information of the logged-in user,
including personal details, contact information, timezone preferences, pagination settings,
and platform access permissions.

The data is fetched from the configured Identity Provider and enriched with platform-specific
metadata such as timezone details.
            
Use cases:

- Display user profile information in account or settings screens
- Pre-fill user details during profile updates
- Determine platform control access for UI feature visibility

### Get current account

 - [GET /api/v1/account/current](https://zonedevelopersdocumentationv1.redocly.app/apis/account-management/paths/~1api~1v1~1account~1current/get.md): This endpoint returns account-level information associated with the
currently authenticated user, including contact details, country,
currency, timezone configuration, and branding information.

The account data is fetched from the configured Identity Provider and
enriched with platform-cached reference data such as country, currency,
and timezone metadata for display purposes.
            
Use cases:

- Display account profile and contact information
- Populate account settings and configuration screens
- Resolve account-level locale, currency, and timezone preferences

### Get account contacts

 - [GET /api/v1/account/contacts](https://zonedevelopersdocumentationv1.redocly.app/apis/account-management/paths/~1api~1v1~1account~1contacts/get.md): This endpoint returns all contact records linked to the currently
active account.

Use cases:

- Display account contacts in management or settings screens
- Select contacts for notifications or communication workflows
- View contact details associated with an account

### Change current user password

 - [POST /api/v1/account/users/me/changepassword](https://zonedevelopersdocumentationv1.redocly.app/apis/account-management/paths/~1api~1v1~1account~1users~1me~1changepassword/post.md): This endpoint allows the logged-in user to update their account password.
The password change request is forwarded to the configured Identity Provider
and processed for the current user only.

Upon successful password change:

- All active user sessions are invalidated except the current session
- The password change timestamp is updated for security tracking

## User Management

### Get account users

 - [POST /api/v1/account/users](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users/post.md): This endpoint returns users belonging to the currently active account,
with support for keyword search, sorting, pagination, and view-specific
formatting.
            
Notes:

- Only users belonging to the current account are returned
- User data is resolved from cached account user information

### Get user details

 - [GET /api/v1/account/users/{useridentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1%7Buseridentifier%7D/get.md): This endpoint returns profile and role-related information for a user
identified by the provided user identifier, scoped to the current account.

Use cases:

- View user profile details in administration screens
- Review assigned roles and permissions
- Prepare user data for edit or role management workflows

### Update account user

 - [POST /api/v1/account/users/{useridentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1%7Buseridentifier%7D/post.md): This endpoint updates profile information and role assignments for
a specified user within the current account.

The user’s email domain is validated against the list of mail domains
configured for the account before the update is processed.

Process overview:

- Validate the user’s email domain
- Update user details through the Identity Provider
- Refresh cached account user data
- Invalidate licensing and permission-related caches

### Add account user

 - [POST /api/v1/account/users/add](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1add/post.md): This endpoint creates a new user within the currently active account
and assigns the specified roles and permissions.

Before user creation, the user’s email domain is validated against
the list of mail domains configured for the account. If the domain
is not allowed, the request is rejected.
            
Process overview:

- Validate the user’s email domain against configured account domains
- Create the user through the Identity Provider
- Update account user caches and licensing state
- Return the newly created user details and role information

### Remove account user

 - [POST /api/v1/account/users/{useridentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1%7Buseridentifier%7D~1remove/post.md): This endpoint deletes a specified user from the currently
active account. The operation is processed through the Identity Provider
and reflected in the account’s user and licensing state.

Process overview:

- Delete the user through the Identity Provider
- Update account user and licensed user caches
- Preserve employee-related metadata where applicable

### Restore account user

 - [POST /api/v1/account/users/{useridentifier}/activate](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1%7Buseridentifier%7D~1activate/post.md): This endpoint reactivates a previously removed user and restores
their access to the current account. The operation is processed
through the Identity Provider and reflected in the account’s user
and licensing state.

Process overview:

- Restore the user through the Identity Provider
- Update cached account user information
- Reapply licensing based on assigned roles

### Reset user password

 - [POST /api/v1/account/users/{useridentifier}/reset](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1%7Buseridentifier%7D~1reset/post.md): This endpoint triggers a password reset for the specified user
within the current account. The reset operation is handled by the
Identity Provider and applies immediately.

Use cases:

- Recover access for users who have forgotten their password
- Enforce password reset for security or compliance reasons

### Get current user account details

 - [GET /api/v1/account/users/me/accountdetails](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1me~1accountdetails/get.md): This endpoint returns account-related information for the logged-in user,
including details of the account the user belongs to and their association
with it.

The data is resolved automatically based on the authenticated user context
and does not require any account or user identifiers in the request.
            
Use cases:

- Display account information in user profile or dashboard screens
- Determine the user’s current account context
- Retrieve account metadata for self-service features

### Update multiple users

 - [POST /api/v1/account/users/update](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1update/post.md): This endpoint allows administrators to perform bulk updates on users
belonging to the current account. It supports updating role assignments
and related account access properties for multiple users in a single request.

Request details:

Accepts a list of user identifiers to be updated
Applies role and access changes uniformly to all specified users

            
Behavior:

- Each user update is processed via the identity management provider
- Updated user data is synchronized with the account cache
- The response includes the updated state for each processed user

### Get active account users

 - [POST /api/v1/account/users/active](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1active/post.md): This endpoint returns active users associated with the current account,
supporting keyword-based filtering, sorting, and pagination.

Behavior:

- Only users in active status are included
- User data is retrieved from the account cache
- The response contains a paginated and sorted user list

### Get user organizational units

 - [GET /api/v1/users/{userId}/organization/structure/units](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1users~1%7Buserid%7D~1organization~1structure~1units/get.md): This endpoint returns the list of organizational units (structure levels)
that the specified user has access to within the organization.

Behavior:

- Fetches organizational access data from the identity management service
- Returns only the organizational units the user is permitted to access
- Results are returned as a flat list of organizational units

### Assign user organizational units

 - [POST /api/v1/users/{userId}/organization/structure/units](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1users~1%7Buserid%7D~1organization~1structure~1units/post.md): This endpoint adds or updates the organizational units (structure levels)
that a user is allowed to access within the organization.

Behavior:

- Accepts a list of organizational unit identifiers in the request body
- Persists user-to-organization access via the identity management service
- Returns the updated list of organizational units assigned to the user

### Unlock user account

 - [POST /api/v1/account/users/{useridentifier}/unlock](https://zonedevelopersdocumentationv1.redocly.app/apis/user-management/paths/~1api~1v1~1account~1users~1%7Buseridentifier%7D~1unlock/post.md): This endpoint unlocks a user account that has been locked due to
security policies such as failed login attempts.

Behavior:

- Invokes the identity management service to unlock the user
- Updates cached user, active user, and basic user details
- Preserves employee-related attributes after unlock

## User Preferences

### Get application preferences

 - [GET /api/v1/account/users/me/preferences](https://zonedevelopersdocumentationv1.redocly.app/apis/user-preferences/paths/~1api~1v1~1account~1users~1me~1preferences/get.md): This endpoint returns the list of application-level preferences
configured for the current user within the active account.

Behavior:
            
- Preferences are returned for the authenticated user.
- Results are scoped to the currently active account.
- Only preferences configured for the user are included.
- If no preferences are configured, an empty collection is returned.
- This endpoint does not modify any data.

## Reference Data

### Get supported time zones

 - [GET /api/v1/timezones](https://zonedevelopersdocumentationv1.redocly.app/apis/reference-data/paths/~1api~1v1~1timezones/get.md): This endpoint returns all time zones supported by the platform,
including UTC offsets, display names, and daylight saving information.
The data is served from the platform cache and does not require
any user or account context.
            
Use cases:

- Populate timezone dropdowns in user or account settings
- Display localized time information
- Validate timezone selections during profile updates

### Get supported file types

 - [GET /api/v1/filetypes](https://zonedevelopersdocumentationv1.redocly.app/apis/reference-data/paths/~1api~1v1~1filetypes/get.md): This endpoint returns all file types supported by the platform,
including file extensions and icon metadata used for display purposes.
The data is served from the platform cache and is sorted alphabetically
by file type name.
            
Use cases:

- Validate file uploads against supported file types
- Display allowed file formats in upload components
- Render file-type icons in the user interface

## Organizational Contacts

### Get organizational contacts

 - [POST /api/v1/account/current/contacts](https://zonedevelopersdocumentationv1.redocly.app/apis/organizational-contacts/paths/~1api~1v1~1account~1current~1contacts/post.md): This endpoint returns organizational contacts associated with
the currently authenticated account.

Behavior:

- Fetches organizational contacts for the current account
- Supports filtering, paging, or sorting via the request model
- Returns a list of organizational contact details

### Add organizational contact

 - [POST /api/v1/account/current/contacts/Add](https://zonedevelopersdocumentationv1.redocly.app/apis/organizational-contacts/paths/~1api~1v1~1account~1current~1contacts~1add/post.md): This endpoint creates a new organizational contact associated with
the currently authenticated account.

Behavior:

- Validates and persists the organizational contact details
- Associates the contact with the current account
- Returns the newly created contact information

### Get organizational contact details

 - [GET /api/v1/account/current/contacts/{orgContactIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/organizational-contacts/paths/~1api~1v1~1account~1current~1contacts~1%7Borgcontactidentifier%7D/get.md): This endpoint returns detailed information for a single
organizational contact associated with the current account.

Behavior:

- Fetches organizational contact details by identifier
- Validates the contact against the current account
- Returns full contact information if found

### Update organizational contact

 - [POST /api/v1/account/current/contacts/{orgContactIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/organizational-contacts/paths/~1api~1v1~1account~1current~1contacts~1%7Borgcontactidentifier%7D/post.md): This endpoint updates the details of an organizational contact
associated with the current account.

Behavior:

- Updates the organizational contact identified by the route parameter
- Validates the contact against the current account
- Persists the updated contact information

## Audit Trails

### Get account audit logs

 - [POST /api/v1/auditing/audittrails](https://zonedevelopersdocumentationv1.redocly.app/apis/audit-trails/paths/~1api~1v1~1auditing~1audittrails/post.md): This endpoint returns audit trail records generated for the current account,
based on the supplied filter criteria such as modules, features, actions,
users, and time range.

The results are normalized to the logged-in user’s timezone and returned
in descending order of event occurrence time.
            
Notes:

- Only audit records belonging to the current account are returned
- Results are enriched with user and account metadata
- Timestamps are converted to the logged-in user’s timezone

## Equipment

### Get filtered assets

 - [POST /api/v1/assets](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets/post.md): This endpoint returns a list of assets associated with the current account
based on the filters specified in the request body.

Behavior:

- Results are scoped to the current account context
- Supports filtering and search based on asset attributes
- Only assets accessible to the user are returned

### Add new general asset

 - [POST /api/v1/assets/general/add](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1add/post.md): Creates a new general asset within the current account context using the provided request data.
            
Behavior:
- Validates manage privilege for equipment
- Creates a new general asset record
- Associates the asset with the current account and user
- Returns the created asset details
- Logs the action as an equipment added event

### Update existing general asset

 - [POST /api/v1/assets/general/{assetIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1%7Bassetidentifier%7D/post.md): Updates the specified general asset within the current account context using the provided request data.
            
Behavior:
- Validates manage privilege for equipment
- Verifies the asset belongs to the account
- Updates asset details based on request data
- Returns the updated asset information
- Logs the action as an equipment updated event

### Get general asset by ID

 - [GET /api/v1/assets/general/{assetIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1%7Bassetidentifier%7D/get.md): Returns detailed information for the specified general asset within the current account context.
            
Behavior:
- Validates the asset belongs to the account
- Retrieves asset details for the given identifier
- Returns structured general asset response data
- Logs the action as an equipment viewed event

### Remove general asset

 - [POST /api/v1/assets/general/{assetIdentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1%7Bassetidentifier%7D~1remove/post.md): Removes the specified general asset from the current account context based on the provided request data.
            
Behavior:
- Validates manage privilege for equipment
- Verifies the asset belongs to the account
- Performs asset removal based on request criteria
- Returns removal status details
- Logs the action as an equipment deleted event

### Get general asset types

 - [GET /api/v1/assets/general/assettypes/list](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1assettypes~1list/get.md): Returns the list of general asset types available within the current account context.
            
Behavior:
- Validates manage or view privilege for asset types
- Retrieves all configured general asset types
- Returns structured asset type response data
- Logs the action as an equipment category list view event

### List general asset classes

 - [POST /api/v1/assets/general/assetclass/list](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1assetclass~1list/post.md): Returns a filtered list of general asset classes within the current account context.
            
Behavior:
- Validates manage or view privilege for asset classes
- Applies keyword filtering from the request body
- Retrieves matching general asset classes
- Returns structured asset class response data
- Logs the action as an equipment type list view event

### Get general asset class

 - [GET /api/v1/assets/general/assetclass/{assetClassIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1assetclass~1%7Bassetclassidentifier%7D/get.md): Returns details of the specified general asset class within the current account context.
            
Behavior:
- Validates manage privilege for asset classes
- Verifies the asset class belongs to the account
- Retrieves asset class details by identifier
- Returns structured asset class response data
- Logs the action as an equipment type view event

### List asset classes by type

 - [GET /api/v1/assets/general/assettypes/{assetTypeIdentifier}/assetclass/list](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1assettypes~1%7Bassettypeidentifier%7D~1assetclass~1list/get.md): Returns the list of asset classes associated with the specified general asset type within the current account context.
            
Behavior:
- Validates the asset type belongs to the account
- Retrieves associated asset classes for the given asset type identifier
- Returns structured asset class response data
- Logs the action as an equipment type list view event

### Get paginated asset classes

 - [POST /api/v1/assets/general/assetclass/list/all](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1assetclass~1list~1all/post.md): Returns a filtered and paginated list of general asset classes within the current account context.
            
Behavior:
- Validates manage or view privilege for asset classes
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves matching asset classes
- Returns structured asset class list response data
- Logs the action as an equipment type list view event

### Get asset tasks

 - [POST /api/v1/assets/{assetId}/tasks](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1%7Bassetid%7D~1tasks/post.md): Returns a filtered and paginated list of tasks associated with the specified asset within the current account context.
            
Behavior:
- Validates the asset belongs to the account
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves tasks linked to the given asset identifier
- Returns structured task list response data
- Logs the action as a task viewed event

### Get asset warranties

 - [POST /api/v1/assets/general/{assetIdentifier}/warranties](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1%7Bassetidentifier%7D~1warranties/post.md): Returns a filtered and paginated list of warranty documents associated with the specified general asset within the current account context.
            
Behavior:
- Validates the asset belongs to the account
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves warranty-type operational documents for the asset
- Returns structured operational document list response data
- Logs the action as an equipment warranty list view event

### Get related assets

 - [POST /api/v1/assets/general/{assetIdentifier}/relatedAssets](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1%7Bassetidentifier%7D~1relatedassets/post.md): Returns related assets associated with the specified general asset within the current account context.
            
Behavior:
- Validates the asset belongs to the account
- Applies relation filter from the request body
- Retrieves assets linked to the given asset identifier
- Returns structured related asset response data
- Logs the action as a related asset view event

### Get asset summary

 - [GET /api/v1/assets/{assetIdentifier}/summary](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1%7Bassetidentifier%7D~1summary/get.md): Returns summary details of the specified asset within the current account context.
            
Behavior:
- Validates the asset belongs to the account
- Retrieves summary information for the given asset identifier
- Returns structured asset summary response data
- Logs the action as an asset summary view event

### List basic assets

 - [POST /api/v1/assets/general/list/basic](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1list~1basic/post.md): Returns basic asset details based on the provided portfolio filters.
            
Behavior:
- Applies portfolio filtering criteria
- Supports pagination using the start parameter
- Returns summarized asset tile information
- Logs the action as equipment tile view

### Get asset changesets

 - [POST /api/v1/assets/general/{assetId}/changesets](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1%7Bassetid%7D~1changesets/post.md): Returns the change history of the specified asset based on the provided filters.
            
Behavior:
- Validates the asset belongs to the account
- Applies changeset filtering criteria
- Supports pagination using limit and start parameters
- Retrieves asset change history records
- Logs the action as equipment changeset view

### Get asset grid list

 - [POST /api/v1/assets/general/basic/list](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1basic~1list/post.md): Returns a filtered and paginated grid list of general assets.
            
Behavior:
- Applies portfolio filtering criteria
- Supports pagination using the start parameter
- Retrieves general assets for the account
- Returns structured asset grid response data
- Logs the action as equipment grid view

### Get basic asset nodes

 - [POST /api/v1/assets/nodes/basic](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1nodes~1basic/post.md): Returns child asset nodes based on the provided portfolio filters and asset type.
            
Behavior:
- Applies portfolio filtering criteria
- Filters results using the asset type identifier
- Retrieves child asset node details
- Returns structured asset node response data
- Logs the action as asset child list view

### List general assets

 - [POST /api/v1/assets/general/list](https://zonedevelopersdocumentationv1.redocly.app/apis/equipment/paths/~1api~1v1~1assets~1general~1list/post.md): Returns a filtered and paginated list of general assets for the current account.
            
Behavior:
- Applies portfolio filtering criteria
- Supports pagination using the start parameter
- Retrieves assets accessible to the current user
- Returns structured general asset list response data
- Logs the action as equipment list view

## Employees

### Adds a new employee

 - [POST /api/v1/portfolio/employees/add](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1add/post.md): Creates a new employee record within the current account context.
            
Behavior:
- Associates the employee with the current account
- Applies validation and business rules before persistence
- Logs the action as an employee creation event

### Removes an employee

 - [POST /api/v1/portfolio/employees/{employeeidentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1remove/post.md): Removes the specified employee from the current account.
            
Behavior:
- Validates employee association with the account
- Applies business rules before removal
- Logs the action as an employee removal event

### Gets employee details

 - [GET /api/v1/portfolio/employees/{employeeIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D/get.md): Retrieves detailed information for the specified employee
within the current account context.
            
Behavior:
- Validates employee association with the account
- Returns complete employee profile information
- Logs the action as an employee view event

### Updates an employee

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D/post.md): Updates the details of the specified employee within the current account context.
            
Behavior:
- Validates employee association with the account
- Applies business rules before updating
- Persists the updated employee information
- Logs the action as an employee update event

### Gets employee files

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/files](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1files/post.md): Retrieves files associated with the specified employee within the current account.
            
Behavior:
- Validates employee access within the account
- Applies filtering or paging based on the request model
- Returns files linked to the employee
- Logs the action as an employee file view event

### Assign employee location

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/location](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1location/post.md): Assigns the specified employee to a location within the current account context.
            
Behavior:
- Validates employee and location within the account
- Applies assignment rules and constraints
- Updates the employee’s location details
- Logs the action as an employee assignment event

### Unassigns employee location

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/location/deassign](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1location~1deassign/post.md): Removes the location assignment for the specified employee within the current account context.
            
Behavior:
- Validates employee association with the account
- Removes the current location assignment
- Updates employee allocation status
- Logs the action as an employee de-assignment event

### Terminates an employee

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/terminate](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1terminate/post.md): Terminates the specified employee within the current account context based on the provided termination details.
            
Behavior:
- Validates employee association with the account
- Applies termination date and related rules
- Updates employee status to terminated
- Prevents further active assignments if applicable
- Logs the action as an employee termination event

### Activates an employee

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/activate](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1activate/post.md): Restores the specified employee to an active status within the current account context.
            
Behavior:
- Validates employee association with the account
- Changes employee status to active
- Re-enables eligibility for assignments and operations
- Logs the action as an employee activation event

### Relocates employee

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/location/move](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1location~1move/post.md): Transfers the specified employee from their current location to another location within the current account context.
            
Behavior:
- Validates employee and target location within the account
- Ensures the employee has an existing active assignment
- Updates the employee’s location to the new assignment
- Maintains historical move records if applicable
- Logs the action as an employee move event

### Assign supervisor

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/assignsupervisor](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1assignsupervisor/post.md): Associates the specified supervisor with the given employee within the current account context.
            
Behavior:
- Validates employee and supervisor within the account
- Ensures supervisor eligibility and role constraints
- Updates reporting hierarchy for the employee
- Maintains hierarchy integrity rules if applicable
- Logs the action as a supervisor assignment event

### Get employee summary

 - [POST /api/v1/portfolio/employees/summary](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1summary/post.md): Returns a consolidated summary of employee-related information for the
current account context.

Behavior:
- Aggregates employee counts and statuses
- Includes active, inactive, assigned, and unassigned employees
- Provides key metrics for reporting or dashboard purposes
- Logs the summary view action

### Update profile image

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/profileimage](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1profileimage/post.md): Updates the employee's profile image within the current account context using the provided file identifier.
Behavior:
- Accepts a file identifier for the new profile image
- Updates the employee's image in the account
- Logs the image upload action
- Returns file details of the uploaded image

### Create employee account

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/createuser](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1createuser/post.md): Creates a system user account associated with the specified employee within the current account context.
            
Behavior:
- Retrieves employee details based on the employee identifier
- Validates employee status before user creation
- Maps employee information to user account fields
- Assigns roles as provided in the request
- Sets account activation and expiry dates
- Creates the user in the identity management system when IsCreateUser is true
- Returns existing employee details if IsCreateUser is false
- Logs the action as a user creation event

### List employees

 - [POST /api/v1/portfolio/employees/all](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1all/post.md): 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

### Get employee qualifications

 - [GET /api/v1/portfolio/employees/{employeeIdentifier}/qualifications](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1qualifications/get.md): Returns the list of qualifications associated with the specified employee within the current account context.
            
Behavior:
- Validates employee association with the account
- Retrieves all recorded qualifications for the employee
- Returns qualification details including relevant metadata
- Logs the action as an employee qualification view event

### Add employee qualification

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/qualifications/add](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1qualifications~1add/post.md): Associates a new qualification with the specified employee within the current account context.
            
Behavior:
- Validates employee association with the account
- Validates qualification details from the request body
- Creates and links the qualification record to the employee
- Returns the newly added qualification details
- Logs the action as an employee qualification addition event

### Remove employee qualification

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/qualifications/{qualificationIdentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1qualifications~1%7Bqualificationidentifier%7D~1remove/post.md): Deletes the specified qualification associated with the given employee within the current account context.
            
Behavior:
- Validates employee and qualification association within the account
- Ensures the qualification exists for the specified employee
- Removes the qualification record
- Returns the removed qualification details if applicable
- Logs the action as an employee qualification removal event

### Convert to technician

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/createtechnician](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1createtechnician/post.md): Updates the specified employee to the technician role within the current account context and associates the provided trades.
            
Behavior:
- Validates employee association with the account
- Validates provided trade identifiers
- Updates employee role to technician
- Associates selected trades with the technician profile
- Returns updated employee details
- Logs the action as an employee role conversion event

### Get move history

 - [GET /api/v1/portfolio/employees/{employeeId}/moves](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeid%7D~1moves/get.md): Returns the historical record of location moves for the specified employee within the current account context.
            
Behavior:
- Validates employee association with the account
- Retrieves chronological move history records
- Includes previous and new location details for each move
- Returns rollback-related information if applicable
- Logs the action as an employee move history view event

### Rollback employee move

 - [POST /api/v1/portfolio/employees/{employeeId}/location/moves/current/rollback](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeid%7D~1location~1moves~1current~1rollback/post.md): Reverts the employee’s most recent location move within the current account context based on the provided rollback details.
            
Behavior:
- Validates employee association with the account
- Ensures a current move exists that is eligible for rollback
- Restores the employee to the previous location state
- Updates move history accordingly
- Returns updated rollback information
- Logs the action as an employee move rollback event

### List employee basic details

 - [GET /api/v1/portfolio/employees/basic](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1basic/get.md): Returns a simplified list of employee details within the current account context.
            
Behavior:
- Retrieves all employees associated with the account
- Returns essential employee information only
- Excludes extended or detailed profile data
- Logs the action as an employee basic details view event

### Updates multiple employees

 - [POST /api/v1/portfolio/employees/update](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1update/post.md): Applies bulk updates to multiple employees within the current account context based on the provided request data.
            
Behavior:
- Validates employee associations with the account
- Processes update rules for multiple employee records
- Applies changes according to the request model
- Returns the updated employee details list
- Logs the action as a multiple employee update event

### Cancels employee termination

 - [POST /api/v1/portfolio/employees/{employeeIdentifier}/cancelTermination](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1canceltermination/post.md): Reverses the termination status of the specified employee within the current account context and restores the employee to an active state where applicable.
            
Behavior:
- Validates employee association with the account
- Ensures the employee is currently in a terminated state
- Reverts termination details and status
- Restores eligibility for assignments and operations if applicable
- Returns updated employee details
- Logs the action as an employee termination cancellation event

### Update employee locations

 - [POST /api/v1/portfolio/employees/locations/update](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1locations~1update/post.md): Applies location updates to one or more employees within the current account context based on the provided request data.
            
Behavior:
- Validates employee associations with the account
- Validates target location details
- Updates location assignments for the specified employees
- Ensures location rules and constraints are enforced
- Logs the action as a bulk employee location update event

### List active employees

 - [POST /api/v1/portfolio/employees/active](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1active/post.md): Returns a filtered and/or paginated list of active employees within the current account context.
            
Behavior:
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves only employees with an active status
- Returns summarised employee view details
- Logs the action as an active employee list view event

### Get paginated employee details

 - [POST /api/v1/portfolio/employees/basic/list](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1basic~1list/post.md): Returns a filtered and/or paginated list of basic employee details within the current account context.
            
Behavior:
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves essential employee information only
- Excludes extended profile or detailed data
- Returns summarised employee basic detail results
- Logs the action as an employee basic details list view event

## Facility

### Get shared space details

 - [GET /api/v1/facility/spaces/shared/{spaceIdentifier}/details](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces~1shared~1%7Bspaceidentifier%7D~1details/get.md): Returns detailed information for the specified shared space within the current account context.
            
Behavior:
- Validates space association with the account
- Retrieves complete space details and related metadata
- Includes configuration and attribute information where applicable
- Returns structured space detail response
- Logs the action as a space details view event

### Get space assignments

 - [GET /api/v1/facility/spaces/{spaceIdentifier}/assignmentinfo](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces~1%7Bspaceidentifier%7D~1assignmentinfo/get.md): Returns assignment-related details for the specified space within the current account context.
            
Behavior:
- Validates space association with the account
- Retrieves current assignment configuration and occupancy details
- Includes allocation rules and related metadata where applicable
- Returns structured space assignment information
- Logs the action as a space assignment information view event

### Get space amenities

 - [GET /api/v1/facility/spaces/{spaceIdentifier}/amenities](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces~1%7Bspaceidentifier%7D~1amenities/get.md): Returns the list of amenities associated with the specified space within the current account context.
            
Behavior:
- Validates space association with the account
- Retrieves all configured amenities for the space
- Returns amenity details and related attributes
- Logs the action as a space amenities view event

### Get space amenity details

 - [GET /api/v1/facility/spaces/{spaceIdentifier}/amenities/{amenityidentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces~1%7Bspaceidentifier%7D~1amenities~1%7Bamenityidentifier%7D/get.md): Returns detailed information for the specified amenity associated with a space within the current account context.
            
Behavior:
- Validates space and amenity association with the account
- Ensures the amenity exists for the specified space
- Retrieves amenity configuration and attribute details
- Returns structured amenity detail response
- Logs the action as a space amenity view event

### Get space workspaces

 - [GET /api/v1/facility/spaces/{spaceIdentifier}/workspaces](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces~1%7Bspaceidentifier%7D~1workspaces/get.md): Returns the list of workspaces associated with the specified space within the current account context.
            
Behavior:
- Validates space association with the account
- Retrieves all workspaces configured under the space
- Returns workspace details and related attributes
- Logs the action as a workspace list view event

### Get workspace details

 - [GET /api/v1/facility/spaces/{spaceIdentifier}/workspaces/{workspaceidentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces~1%7Bspaceidentifier%7D~1workspaces~1%7Bworkspaceidentifier%7D/get.md): Returns detailed information for the specified workspace associated with a space within the current account context.
            
Behavior:
- Validates space and workspace association with the account
- Ensures the workspace exists under the specified space
- Retrieves workspace configuration and attribute details
- Returns structured workspace detail response
- Logs the action as a workspace view event

### List spaces

 - [POST /api/v1/facility/spaces](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces/post.md): Returns a filtered and/or paginated list of spaces within the current account context.
            
Behavior:
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves spaces associated with the account
- Returns summarized space detail results
- Logs the action as a spaces list view event

### Get space summary

 - [POST /api/v1/facility/spaces/summary](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces~1summary/post.md): Returns aggregated summary details for spaces within the current account context based on the provided request criteria.
            
Behavior:
- Applies summary filters from the request body
- Aggregates space-related metrics and statistics
- Retrieves summary data scoped to the account
- Returns structured space summary response
- Logs the action as a space summary view event

### Get workspaces by room hierarchy

 - [GET /api/v1/facility/spaces/locations/{locationId}/buildings/{buildingId}/levels/{levelId}/workSpaces](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces~1locations~1%7Blocationid%7D~1buildings~1%7Bbuildingid%7D~1levels~1%7Blevelid%7D~1workspaces/get.md): Returns the list of workspaces under the specified location, building, and level within the current account context.
            
Behavior:
- Validates location, building, and level association with the account
- Retrieves workspaces mapped to the specified hierarchy
- Returns workspace details and related metadata
- Logs the action as a room workspaces view event

### Get space grid list

 - [POST /api/v1/facility/spaces/list](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1facility~1spaces~1list/post.md): Returns a filtered and paginated grid-style list of spaces within the current account context.
            
Behavior:
- Applies filtering criteria from the request body
- Uses the start query parameter for pagination
- Retrieves spaces associated with the account
- Returns structured grid/list response data
- Logs the action as a space grid view event

### List related shared spaces

 - [POST /api/v1/spaces/{spaceId}/shared/all](https://zonedevelopersdocumentationv1.redocly.app/apis/facility/paths/~1api~1v1~1spaces~1%7Bspaceid%7D~1shared~1all/post.md): Returns the list of shared spaces associated with the specified space within the current account context.
            
Behavior:
- Validates space association with the account
- Retrieves all shared space records linked to the specified space
- Returns structured shared space list response
- Logs the action as a shared space view event

## Furniture

### Add furniture asset

 - [POST /api/v1/furniture/add](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1add/post.md): Creates a new furniture asset within the current account context.
            
Behavior:
- Resolves the furniture asset type for the account
- Applies asset details from the request body
- Creates the furniture asset record
- Returns the newly created asset details
- Logs the action as a furniture addition event

### Update furniture asset

 - [POST /api/v1/furniture/{assetIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1%7Bassetidentifier%7D/post.md): Updates the specified furniture asset within the current account context.
            
Behavior:
- Validates asset association with the account
- Resolves the furniture asset type for the account
- Applies updated asset details from the request body
- Persists changes to the furniture asset record
- Returns the updated asset details
- Logs the action as a furniture update event

### Get furniture asset details

 - [GET /api/v1/furniture/{assetIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1%7Bassetidentifier%7D/get.md): Returns detailed information for the specified furniture asset within the current account context.
            
Behavior:
- Validates asset association with the account
- Retrieves furniture asset details and related metadata
- Returns structured asset detail response
- Logs the action as a furniture view event

### Remove furniture asset

 - [POST /api/v1/furniture/{assetIdentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1%7Bassetidentifier%7D~1remove/post.md): Removes the specified furniture asset within the current account context based on the provided removal details.
            
Behavior:
- Validates asset association with the account
- Applies removal rules from the request body
- Marks or deletes the furniture asset as per business logic
- Returns removal confirmation details
- Logs the action as a furniture removal event

### List furniture assets

 - [POST /api/v1/furniture/list](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1list/post.md): Returns a filtered and/or paginated list of furniture assets within the current account context.
            
Behavior:
- Resolves the furniture asset type for the account
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves furniture assets associated with the account
- Returns structured furniture list response data
- Logs the action as a furniture list view event

### List furniture asset types

 - [GET /api/v1/furniture/assettypes/list](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1assettypes~1list/get.md): Returns the list of available furniture asset types within the current account context.
            
Behavior:
- Retrieves asset types configured for furniture
- Filters asset types based on account scope
- Returns asset type identifiers and descriptive details
- Logs the action as a furniture asset type list view event

### List furniture asset classes

 - [POST /api/v1/furniture/assetclass/list](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1assetclass~1list/post.md): Returns the list of available furniture asset classes within the current account context based on the provided search criteria.
            
Behavior:
- Applies keyword filtering from the request body
- Retrieves asset classes configured for furniture
- Filters results based on account scope
- Returns asset class identifiers and descriptive details
- Logs the action as a furniture asset class list view event

### Get asset class details

 - [GET /api/v1/furniture/assetclass/{assetClassIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1assetclass~1%7Bassetclassidentifier%7D/get.md): Returns detailed information for the specified furniture asset class within the current account context.
            
Behavior:
- Validates asset class association with the account
- Retrieves asset class configuration and descriptive details
- Returns structured asset class detail response
- Logs the action as a furniture asset class view event

### List asset classes by type

 - [GET /api/v1/furniture/assettypes/{assetTypeIdentifier}/assetclass/list](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1assettypes~1%7Bassettypeidentifier%7D~1assetclass~1list/get.md): Returns the list of asset classes associated with the specified furniture asset type within the current account context.
            
Behavior:
- Validates asset type association with the account
- Retrieves all asset classes linked to the specified asset type
- Returns asset class identifiers and descriptive details
- Logs the action as a furniture asset type classes view event

### Update furniture asset image

 - [POST /api/v1/furniture/{assetIdentifier}/assetimage](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1%7Bassetidentifier%7D~1assetimage/post.md): Uploads or replaces the image associated with the specified furniture asset within the current account context.
            
Behavior:
- Validates asset association with the account
- Validates provided file identifier
- Associates the file as the asset image
- Updates existing image if one already exists
- Returns updated file detail information
- Logs the action as an asset image upload event

### Get furniture asset status

 - [GET /api/v1/furniture/{assetIdentifier}/status](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1%7Bassetidentifier%7D~1status/get.md): Returns the current status information for the specified furniture asset within the current account context.
            
Behavior:
- Validates asset association with the account
- Retrieves current status details of the asset
- Returns structured status information response
- Logs the action as an asset status view event

### Update furniture asset status

 - [POST /api/v1/furniture/{assetIdentifier}/status](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1%7Bassetidentifier%7D~1status/post.md): Updates the current status of the specified furniture asset within the current account context based on the provided status details.
            
Behavior:
- Validates asset association with the account
- Validates status details from the request body
- Applies status change according to business rules
- Persists updated status information
- Returns updated status details
- Logs the action as an asset status update event

### Updates multiple furniture assets

 - [POST /api/v1/furniture/update](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1update/post.md): Applies bulk updates to multiple furniture assets within the current account context based on the provided request data.
            
Behavior:
- Resolves the furniture asset type for the account
- Validates asset associations within the account
- Processes update rules for multiple asset records
- Applies changes according to the request model
- Returns the updated furniture asset details list
- Logs the action as a multiple furniture update event

### Get paginated asset classes

 - [POST /api/v1/furniture/assetclass/list/all](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1assetclass~1list~1all/post.md): Returns a filtered and paginated list of furniture asset classes within the current account context.
            
Behavior:
- Applies filtering criteria from the request body
- Uses the start query parameter for pagination
- Retrieves asset classes associated with furniture
- Returns structured asset class list response data
- Logs the action as a furniture asset class list view event

### Get related furniture assets

 - [POST /api/v1/furniture/{assetIdentifier}/relatedAssets](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1%7Bassetidentifier%7D~1relatedassets/post.md): Returns assets related to the specified furniture asset within the current account context based on the provided relation criteria.
            
Behavior:
- Validates asset association with the account
- Applies relation type filtering from the request body
- Retrieves assets linked to the specified asset
- Returns structured related asset details
- Logs the action as a related asset view event

### Get grouped asset locations

 - [POST /api/v1/furniture/{assetIdentifier}/assetlocation/list](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1%7Bassetidentifier%7D~1assetlocation~1list/post.md): Returns a grouped list of location instances associated with the specified furniture asset within the current account context.
            
Behavior:
- Validates asset association with the account
- Applies filtering criteria from the request body if provided
- Retrieves asset instance locations grouped by hierarchy or category
- Returns structured grouped location response data
- Logs the action as an asset instance location list view event

### Get asset instance location details

 - [GET /api/v1/furniture/assetlocation/{assetLocationIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1assetlocation~1%7Bassetlocationidentifier%7D/get.md): Returns detailed information for the specified furniture asset instance location within the current account context.
            
Behavior:
- Validates asset location identifier
- Retrieves grouped asset location details and related metadata
- Returns structured asset instance location response
- Logs the action as an asset instance location view event

### Update asset instance location

 - [POST /api/v1/furniture/assetlocation/{assetLocationIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1assetlocation~1%7Bassetlocationidentifier%7D/post.md): Updates the specified furniture asset instance location within the current account context based on the provided request details.
            
Behavior:
- Validates asset location association with the account
- Validates update details from the request body
- Applies changes to the grouped asset location record
- Persists updated location information
- Returns updated asset instance location details
- Logs the action as an asset instance location update event

### Get paginated furniture basics

 - [POST /api/v1/furniture/basic/list](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1basic~1list/post.md): Returns a filtered and paginated list of basic furniture asset details within the current account context.
            
Behavior:
- Resolves the furniture asset type for the account
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves essential furniture asset information only
- Returns structured basic asset list response data
- Logs the action as a furniture basic list view event

### Get furniture changeset history

 - [POST /api/v1/furniture/{assetId}/changesets](https://zonedevelopersdocumentationv1.redocly.app/apis/furniture/paths/~1api~1v1~1furniture~1%7Bassetid%7D~1changesets/post.md): Returns the changeset history for the specified furniture asset within the current account context based on the provided request criteria.
            
Behavior:
- Validates asset association with the account
- Applies filtering criteria from the request body
- Supports pagination using limit and start query parameters
- Retrieves historical changesets for the asset
- Returns structured changeset history response
- Logs the action as a furniture changeset view event

## Portfolio

### Get portfolio details

 - [GET /api/v1/portfolio](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio/get.md): Returns the portfolio hierarchy for the current account and user.
            
Behavior:
- Validates account and user context
- Retrieves accessible portfolio locations
- Returns structured location response data
- Logs the action as a map view

### Get portfolio locations

 - [GET /api/v1/portfolio/locations](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations/get.md): Returns all accessible locations within the current account context.
            
Behavior:
- Validates account and user context
- Retrieves location records associated with the portfolio
- Returns structured location response data
- Logs the action as a location view

### List buildings by location

 - [GET /api/v1/portfolio/locations/{locationidentifier}/buildings](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings/get.md): Returns the list of buildings associated with the specified location within the current account context.
            
Behavior:
- Validates the location belongs to the account
- Retrieves buildings linked to the given location identifier
- Returns structured building response data
- Logs the action as a building's view

### List levels by building

 - [GET /api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels/get.md): Returns the list of levels associated with the specified building within the current account context.
            
Behavior:
- Validates the building belongs to the account
- Retrieves levels linked to the given building identifier
- Returns structured building level response data
- Logs the action as building levels view

### Add level to building

 - [POST /api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/add](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1add/post.md): Creates a new level under the specified building and location within the current account context.
            
Behavior:
- Validates manage privilege for portfolio/buildings
- Verifies location and building belong to the account
- Creates a new building level using request data
- Returns the created level details
- Logs the action as level added

### Add building to location

 - [POST /api/v1/portfolio/locations/{locationidentifier}/buildings/add](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1add/post.md): Creates a new building under the specified location within the current account context.
            
Behavior:
- Validates manage privilege for portfolio/buildings
- Verifies the location belongs to the account
- Creates a new building using request data
- Returns the created building details
- Logs the action as building added

### List building plans

 - [GET /api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/plans](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1plans/get.md): Returns the list of CAD plans associated with the specified building and location within the current account context.
            
Behavior:
- Validates building and location belong to the account
- Retrieves CAD plan records for the given identifiers
- Returns structured building plan response data
- Logs the action as building plans view

### List level plans

 - [GET /api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/{levelidentifier}/plans](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1plans/get.md): Returns the list of CAD plans associated with the specified level within the current account context.
            
Behavior:
- Validates the level belongs to the account
- Retrieves CAD plan records for the given level identifier
- Returns structured level plan response data
- Logs the action as a level plan's view

### List location plans

 - [GET /api/v1/portfolio/locations/{locationidentifier}/plans](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1plans/get.md): Returns the list of CAD plans associated with the specified location within the current account context.
            
Behavior:
- Validates manage or view privilege for portfolio
- Verifies the location belongs to the account
- Retrieves CAD plan records for the given location identifier
- Returns structured location plan response data
- Logs the action as site plans view

### Get location details

 - [GET /api/v1/portfolio/locations/{locationidentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D/get.md): Returns detailed information for the specified location within the current account context.
            
Behavior:
- Validates the location belongs to the account
- Retrieves detailed location information
- Returns structured location details response data
- Logs the action as a location details view

### Update location

 - [POST /api/v1/portfolio/locations/{locationIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D/post.md): Updates the specified location within the current account context.
            
Behavior:
- Validates manage privilege for portfolio
- Verifies the location belongs to the account
- Updates location details using request data
- Returns the updated location details
- Logs the action as the site updated

### Get building details

 - [GET /api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D/get.md): Returns detailed information for the specified building within the given location and current account context.
            
Behavior:
- Validates that the building and location belong to the account
- Retrieves detailed building information
- Returns structured building details response data
- Logs the action as building details view

### Get level details

 - [GET /api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/{levelidentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D/get.md): Returns detailed information for the specified level within the given building, location, and current account context.
            
Behavior:
- Validates the level, building, and location belong to the account
- Retrieves detailed level information
- Returns structured level details response data
- Logs the action as level details view

### Update building details

 - [POST /api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D/post.md): Updates the specified building within the given location and current account context.
            
Behavior:
- Validates manage privilege for portfolio/buildings
- Verifies the building and location belong to the account
- Updates building details using request data
- Returns the updated building details
- Logs the action as building updated

### Update level details

 - [POST /api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D/post.md): Updates the specified level within the given building, location, and current account context.
            
Behavior:
- Validates manage privilege for portfolio/buildings
- Verifies the level, building, and location belong to the account
- Updates level details using request data
- Returns the updated level details
- Logs the action as level updated

### List spaces by level

 - [GET /api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/{levelidentifier}/spaces](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1spaces/get.md): Returns the list of spaces associated with the specified level within the current account context.
            
Behavior:
- Validates the level belongs to the account
- Retrieves space details for the given level identifier
- Returns structured space list response data
- Logs the action as space details view

### Get space details

 - [GET /api/v1/portfolio/locations/{locationidentifier}/buildings/{buildingidentifier}/levels/{levelidentifier}/spaces/{spaceIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1spaces~1%7Bspaceidentifier%7D/get.md): Returns detailed information for the specified space within the current account context.
            
Behavior:
- Validates the space belongs to the account
- Retrieves detailed space information by identifier
- Returns structured space detail response data
- Logs the action as space viewed

### List employees by level

 - [GET /api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/employees](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1employees/get.md): Returns employees associated with the specified location, building, and level within the current account context.
            
Behavior:
- Supports optional detailed view when details=yes
- Supports keyword-based filtering
- Validates hierarchy belongs to the account
- Returns structured employee details list
- Logs the action as employees viewed

### List other employees by level

 - [POST /api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/employees/others](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1employees~1others/post.md): Returns additional employees for the specified location, building, and level within the current account context.
            
Behavior:
- Supports pagination using start query parameter
- Accepts filter criteria in request body
- Validates hierarchy belongs to the account
- Returns structured employee response data
- Logs the action as other employees viewed

### Remove location

 - [POST /api/v1/portfolio/locations/{locationIdentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1remove/post.md): Deletes the specified location within the current account context.
            
Behavior:
- Requires portfolio management privileges
- Validates the location belongs to the account
- Removes the location and related associations
- Returns the deletion response model
- Logs the action as site deleted

### Remove building

 - [POST /api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1remove/post.md): Deletes the specified building within the current account context.
            
Behavior:
- Requires portfolio management privileges
- Validates the building belongs to the account
- Removes the building and related data
- Returns the deletion response model
- Logs the action as building deleted

### Remove level

 - [POST /api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1remove/post.md): Deletes the specified level within the current account context.
            
Behavior:
- Requires portfolio management privileges
- Validates the level belongs to the account
- Removes the level and related associations
- Returns the deletion response model
- Logs the action as level deleted

### Get location geometry

 - [GET /api/v1/portfolio/locations/{locationIdentifier}/location](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1location/get.md): Returns the geometry details of the specified location within the current account context.
            
Behavior:
- Validates the location belongs to the account
- Retrieves geometry and spatial data for the location
- Returns structured location geometry response data
- Logs the action as a location geometry view

### Update location geometry

 - [POST /api/v1/portfolio/locations/{locationIdentifier}/location](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1location/post.md): Updates the geometry data of the specified location within the current account context.
            
Behavior:
- Validates the location belongs to the account
- Updates spatial/geometry data using the provided feature collection
- Persists updated geometry information
- Returns the updated location geometry response
- Logs the action as location geometry updated

### Get all employees

 - [POST /api/v1/portfolio/employees](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1employees/post.md): Returns a filtered and paginated list of employees within the current account context.
            
Behavior:
- Supports pagination using the start query parameter
- Applies filtering criteria from the request body
- Retrieves employees accessible to the current user
- Returns structured employee response data
- Logs the action as employee list view

### List rooms by level

 - [GET /api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1rooms/get.md): Returns the list of rooms associated with the specified level within the current account context.
            
Behavior:
- Validates the level belongs to the account
- Retrieves room details for the given level identifier
- Returns structured room response data
- Logs the action as rooms viewed

### List workspaces by room

 - [GET /api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms/{roomIdentifier}/workspaces](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1rooms~1%7Broomidentifier%7D~1workspaces/get.md): Returns the list of workspaces associated with the specified room within the current account context.
            
Behavior:
- Validates the room belongs to the account
- Retrieves workspace details for the given room identifier
- Returns structured workspace response data
- Logs the action as workspaces viewed

### Activate location

 - [POST /api/v1/portfolio/locations/{locationIdentifier}/activate](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1activate/post.md): Activates the specified location within the current account context, optionally including its buildings and levels.
            
Behavior:
- Requires portfolio management privileges
- Validates the location belongs to the account
- Activates the location and optionally related buildings and floors
- Returns updated location details
- Logs the action as location activated

### Inactivate location

 - [POST /api/v1/portfolio/locations/{locationIdentifier}/inactivate](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1inactivate/post.md): Deactivates the specified location within the current account context.
            
Behavior:
- Requires portfolio management privileges
- Validates the location belongs to the account
- Performs in-use validation before inactivation
- Deactivates the location upon confirmation
- Returns in-use check response details
- Logs the action as location deactivated

### List location

 - [POST /api/v1/portfolio/locations/list](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1list/post.md): 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

### List buildings

 - [POST /api/v1/portfolio/locations/buildings/list](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1buildings~1list/post.md): Returns a filtered and paginated list of buildings within the current account context.
            
Behavior:
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves buildings accessible to the current user
- Returns structured building list response data
- Logs the action as building grid view

### List levels

 - [POST /api/v1/portfolio/locations/buildings/levels/list](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1buildings~1levels~1list/post.md): Returns a filtered and paginated list of levels within the current account context.
            
Behavior:
- Applies filtering criteria from the request body
- Supports pagination using the start query parameter
- Retrieves levels accessible to the current user
- Returns structured level list response data
- Logs the action as a level list view

### List rooms and workspaces by level

 - [GET /api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms/workspaces](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1rooms~1workspaces/get.md): Returns rooms and their associated workspaces for the specified level within the current account context.
            
Behavior:
- Validates the level belongs to the account
- Retrieves rooms along with related workspace details
- Returns structured room and workspace response data
- Logs the action as spaces viewed

### List reserved workspaces by room

 - [GET /api/v1/portfolio/locations/{locationIdentifier}/buildings/{buildingIdentifier}/levels/{levelIdentifier}/rooms/{roomIdentifier}/workspaces/reserved](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1locations~1%7Blocationidentifier%7D~1buildings~1%7Bbuildingidentifier%7D~1levels~1%7Blevelidentifier%7D~1rooms~1%7Broomidentifier%7D~1workspaces~1reserved/get.md): Returns the list of reserved workspaces associated with the specified room.
            
Behavior:
- Validates the room identifier
- Retrieves reserved workspace records for the room
- Returns structured workspace response data
- Logs the action as workspaces viewed

### Get all portfolio details

 - [GET /api/v1/portfolio/all](https://zonedevelopersdocumentationv1.redocly.app/apis/portfolio/paths/~1api~1v1~1portfolio~1all/get.md): Returns the complete portfolio hierarchy for the current account and user.
            
Behavior:
- Validates account and user context
- Retrieves all accessible portfolio locations
- Returns structured portfolio response data
- Logs the action as portfolio details view

## File Management

### Download file by ID

 - [POST /api/v1/general/files/{fileIdentifier}/download](https://zonedevelopersdocumentationv1.redocly.app/apis/file-management/paths/~1api~1v1~1general~1files~1%7Bfileidentifier%7D~1download/post.md): This endpoint streams the requested file as an attachment for download.

Behavior:

- Validates file access against the current account and user
- Determines the appropriate MIME type automatically
- Sets content headers to force file download
- Captures download metadata for auditing purposes

## Filegroups

### Get active file groups

 - [GET /api/v1/filegroups](https://zonedevelopersdocumentationv1.redocly.app/apis/filegroups/paths/~1api~1v1~1filegroups/get.md): This endpoint returns all active file groups configured
under the current account context.

Behavior:

- Only active file groups are included
- Results are scoped to the authenticated account
- Used to populate file classification or upload options

## Tasks

### Get reactive work order tiles

 - [POST /api/v2/maintenance/reactiveworkorders/basic](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v2~1maintenance~1reactiveworkorders~1basic/post.md): Returns a paginated list of reactive work order tiles for the current user within the account context.
            
Behavior:
- Validates account and user context
- Supports pagination using the start query parameter
- Retrieves reactive work order tile data
- Returns structured reactive work order tile response data
- Logs the action as a reactive work orders tile view

### Get pending tasks for My Work

 - [POST /api/v2/maintenance/mywork/pendingtasks/list](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v2~1maintenance~1mywork~1pendingtasks~1list/post.md): Returns a filtered and paginated list of pending tasks assigned to the current user.
            
Behavior:
- Validates account and user context
- Supports pagination using the start query parameter
- Applies grouping filter using GroupCode from request body
- Retrieves pending tasks assigned to the user
- Returns structured pending task list response data
- Logs the action as a pending tasks grid view

### Get user tasks

 - [POST /api/v1/tm/users/me/tasks](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1users~1me~1tasks/post.md): Returns tasks assigned to the current user within the account context.
            
Behavior:
- Validates account and user context
- Applies filtering using request parameters
- Retrieves tasks assigned to the user
- Returns structured task response data
- Logs the action as my tasks view

### Get task details

 - [GET /api/v1/tm/tasks/{taskid}](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1tasks~1%7Btaskid%7D/get.md): Returns detailed information for the specified task within the current account context.
            
Behavior:
- Validates account and user context
- Verifies the task belongs to the account
- Retrieves detailed task information
- Returns structured task detail response data
- Logs the action as task details view

### Get task history

 - [GET /api/v1/tm/tasks/{taskid}/history](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1tasks~1%7Btaskid%7D~1history/get.md): Returns the history of actions performed on the specified task within the current account context.
            
Behavior:
- Validates account and user context
- Verifies the task belongs to the account
- Retrieves task history records
- Returns structured task history response data
- Logs the action as task history view

### Get request details

 - [GET /api/v1/tm/users/me/requests/{requestId}](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1users~1me~1requests~1%7Brequestid%7D/get.md): Returns detailed information for the specified user request within the current account context.
            
Behavior:
- Validates the request belongs to the account
- Retrieves detailed request information
- Returns structured request detail response data
- Logs the action as a request details view

### Complete a task

 - [POST /api/v1/tm/tasks/{taskid}/complete](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1tasks~1%7Btaskid%7D~1complete/post.md): Marks the specified task as completed within the current account context.
            
Behavior:
- Validates account and user context
- Verifies the task belongs to the account
- Processes task completion using provided action details
- Updates the task status to completed
- Returns the updated task response data
- Logs the action as task completed

### Close a task

 - [POST /api/v1/tm/tasks/{taskid}/close](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1tasks~1%7Btaskid%7D~1close/post.md): Closes the specified task within the current account context.
            
Behavior:
- Validates account and user context
- Verifies the task belongs to the account
- Processes task closure using provided action details
- Updates the task status to closed
- Returns the updated task response data
- Logs the action as the task closed

### Complete and close a task

 - [POST /api/v1/tm/tasks/{taskid}/completeandclose](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1tasks~1%7Btaskid%7D~1completeandclose/post.md): Marks the specified task as completed and closed within the current account context.
            
Behavior:
- Validates account and user context
- Verifies the task belongs to the account
- Processes completion and closure using provided action details
- Updates the task status to completed and closed
- Returns the updated task response data
- Logs the action as task completed and closed

### Get task summary counts

 - [GET /api/v1/tm/tasks/summary](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1tasks~1summary/get.md): Returns aggregated task counts for the current user within the account context.
            
Behavior:
- Validates account and user context
- Retrieves task count metrics for the user
- Returns structured task dashboard summary data
- Logs the action as task count view

### Reopen a task

 - [POST /api/v1/tm/tasks/{taskid}/reopen](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1tasks~1%7Btaskid%7D~1reopen/post.md): Reopens the specified task within the current account context.
            
Behavior:
- Validates account and user context
- Verifies the task belongs to the account
- Reassigns and reopens the task using provided details
- Updates the task status to reopened
- Returns the updated task response data
- Logs the action as the task reopened

### Get active task labors

 - [POST /api/v1/tm/tasks/{taskId}/activelabors](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1tasks~1%7Btaskid%7D~1activelabors/post.md): Returns the list of active labor entries associated with the specified task within the current account context.
            
Behavior:
- Validates account and user context
- Verifies the task belongs to the account
- Retrieves active labor records using provided request details
- Returns structured task labor response data
- Logs the action as an active task labor view

### Stop task labors

 - [POST /api/v1/tm/tasks/{taskId}/stoplabors](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1tasks~1%7Btaskid%7D~1stoplabors/post.md): Stops active labor entries associated with the specified task within the current account context.
            
Behavior:
- Validates account and user context
- Verifies the task belongs to the account
- Stops active labor records using the provided labor details
- Updates task labor status accordingly
- Returns the updated task response data
- Logs the action as task laborers stopped

### Get user request list

 - [GET /api/v1/tm/users/me/requests/list](https://zonedevelopersdocumentationv1.redocly.app/apis/tasks/paths/~1api~1v1~1tm~1users~1me~1requests~1list/get.md): Returns a paginated list of service requests created by the current user within the account context.
            
Behavior:
- Validates account and user context
- Supports pagination using the start query parameter
- Retrieves service requests associated with the user
- Returns structured service request list response data
- Logs the action as request list view

## Service Requests

### Get returned requests for the current user

 - [GET /api/v2/myrequests/users/me/returnedrequests/basic](https://zonedevelopersdocumentationv1.redocly.app/apis/service-requests/paths/~1api~1v2~1myrequests~1users~1me~1returnedrequests~1basic/get.md): Returns the list of requests that were returned to the current user within the account context.
            
Behavior:
- Validates account and user context
- Retrieves returned service requests assigned to the user
- Returns a structured list of request data
- Logs the action as returned requests view

### Get request history

 - [GET /api/v2/myrequests/requests/{requestId}/history](https://zonedevelopersdocumentationv1.redocly.app/apis/service-requests/paths/~1api~1v2~1myrequests~1requests~1%7Brequestid%7D~1history/get.md): Returns the history of actions performed on the specified request within the current account context.
            
Behavior:
- Validates account and user context
- Retrieves history records for the specified request
- Returns structured request history response data

### Create a service request

 - [POST /api/v2/maintenance/servicerequest/createrequest](https://zonedevelopersdocumentationv1.redocly.app/apis/service-requests/paths/~1api~1v2~1maintenance~1servicerequest~1createrequest/post.md): Creates a new service request within the current account context for the logged-in user.
            
Behavior:
- Validates account and user context
- Creates a new service request using request data
- Generates a request number
- Returns the created service request details
- Logs the action as a service request created

### Create a service request

 - [POST /api/v1/maintenance/servicerequests/create](https://zonedevelopersdocumentationv1.redocly.app/apis/service-requests/paths/~1api~1v1~1maintenance~1servicerequests~1create/post.md): Creates a new service request within the current account context using the provided request details.
            
Behavior:
- Validates account and user context
- Processes the service request creation data
- Generates a new service request record
- Returns the created service request response
- Logs the action as a service request created

### Get service request details

 - [GET /api/v1/maintenance/servicerequests/{serviceRequestId}](https://zonedevelopersdocumentationv1.redocly.app/apis/service-requests/paths/~1api~1v1~1maintenance~1servicerequests~1%7Bservicerequestid%7D/get.md): Returns detailed information for the specified service request within the current account context.
            
Behavior:
- Validates the service request belongs to the account
- Retrieves detailed service request information
- Returns structured service request detail response data
- Logs the action as service request detail view

### Update service request details

 - [POST /api/v1/maintenance/servicerequests/{serviceRequestId}](https://zonedevelopersdocumentationv1.redocly.app/apis/service-requests/paths/~1api~1v1~1maintenance~1servicerequests~1%7Bservicerequestid%7D/post.md): Updates the specified service request within the current account context.
            
Behavior:
- Validates account and user context
- Verifies the service request belongs to the account
- Updates service request details using request data
- Returns the updated service request response

### Accept a service request

 - [POST /api/v1/maintenance/servicerequests/{serviceRequestId}/accept](https://zonedevelopersdocumentationv1.redocly.app/apis/service-requests/paths/~1api~1v1~1maintenance~1servicerequests~1%7Bservicerequestid%7D~1accept/post.md): /// Sets the service request status to accepted for the current account.
            
Behavior:
- Validates account and user context
- Verifies the service request belongs to the account
- Updates the service request status to accepted
- Returns the updated service request response
- Logs the action as service request status update

## PM Work Orders

### Get PM work order tiles

 - [POST /api/v2/maintenance/pmworkorders/basic](https://zonedevelopersdocumentationv1.redocly.app/apis/pm-work-orders/paths/~1api~1v2~1maintenance~1pmworkorders~1basic/post.md): Returns a paginated list of preventive maintenance work order tiles for the current user within the account context.
            
Behavior:
- Validates account and user context
- Supports pagination using the start query parameter
- Retrieves preventive maintenance work order tile data
- Returns structured PM work order tile response data
- Logs the action as PM work orders tile view