Get Active Legal Hold Devices

Retrieve a paginated list of all assets currently under active legal hold.

GET
/legal-hold/active-holds

Description

The Get Active Legal Hold Devices API allows you to view a list of assets that are currently in active legal hold status. This endpoint supports pagination for managing large datasets and returns comprehensive device information including placement dates, asset details, and current status.

Request

Headers

HeaderValueRequired
AuthorizationBearer <token>Yes

Query Parameters

ParameterTypeRequiredDescription
pagenumberYesPage number for pagination
limitnumberNoNumber of records per page (default is 10)

Response

Response Fields

FieldTypeDescription
successbooleanIndicates whether the request was successful
messagestringStatus message describing the result
dataarrayArray of legal hold asset objects
data[].idnumberUnique identifier for the legal hold record
data[].asset_idnumber | nullInternal asset identifier
data[].customer_asset_idstring | nullCustomer-provided asset identifier
data[].placed_onstringDate when legal hold was placed (formatted)
data[].age_on_holdstringDuration the asset has been on hold
data[].serial_numberstringDevice serial number
data[].asset_namestringName or identifier of the asset
data[].manufacturer_namestringManufacturer of the device
data[].product_type_namestringType of product (e.g., "Laptop", "Desktop")
data[].status_namestringCurrent status of the asset (e.g., "Legal Hold")
data[].status_type_namestringStatus category (e.g., "Undeployable")
data[].asset_locationstring | nullCurrent physical location of the asset
data[].last_assigneestring | nullName of the last person assigned to the asset
current_pagenumberCurrent page number in the result set
per_pagenumberNumber of items per page
totalnumberTotal number of legal hold assets
last_pagenumberLast page number in the result set

Error Responses

Common error responses you may encounter when using this endpoint.

Notes

  • The endpoint supports pagination to efficiently handle large datasets of legal hold assets.
  • Default page size is 10 items. You can adjust this using the limit parameter.
  • The age_on_hold field provides a human-readable duration showing how long the device has been held.
  • All devices in the response have status_name set to "Legal Hold" and status_type_name set to "Undeployable".
  • Null values for asset_location and last_assignee indicate the information is not available.
  • Use the total and last_page fields to implement pagination controls in your application.

Related Endpoints

Did this page help you?