Get Active Legal Hold Devices
Retrieve a paginated list of all assets currently under active legal hold.
GET
/legal-hold/active-holdsDescription
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
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <token> | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | Yes | Page number for pagination |
| limit | number | No | Number of records per page (default is 10) |
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful |
| message | string | Status message describing the result |
| data | array | Array of legal hold asset objects |
| data[].id | number | Unique identifier for the legal hold record |
| data[].asset_id | number | null | Internal asset identifier |
| data[].customer_asset_id | string | null | Customer-provided asset identifier |
| data[].placed_on | string | Date when legal hold was placed (formatted) |
| data[].age_on_hold | string | Duration the asset has been on hold |
| data[].serial_number | string | Device serial number |
| data[].asset_name | string | Name or identifier of the asset |
| data[].manufacturer_name | string | Manufacturer of the device |
| data[].product_type_name | string | Type of product (e.g., "Laptop", "Desktop") |
| data[].status_name | string | Current status of the asset (e.g., "Legal Hold") |
| data[].status_type_name | string | Status category (e.g., "Undeployable") |
| data[].asset_location | string | null | Current physical location of the asset |
| data[].last_assignee | string | null | Name of the last person assigned to the asset |
| current_page | number | Current page number in the result set |
| per_page | number | Number of items per page |
| total | number | Total number of legal hold assets |
| last_page | number | Last 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?
Request Example
curl -X GET https://dev-api.unduit.com/legal-hold/active-holds?page=1&limit=10 \
-H "Authorization: Bearer <token>"Success Response (200)
{
"success": true,
"message": "Active legal hold assets retrieved successfully",
"data": [
{
"id": 27579,
"asset_id": null,
"customer_asset_id": null,
"placed_on": "Jan 13, 2026",
"age_on_hold": "< 1 Day",
"serial_number": "aabbccddee",
"asset_name": "Jakeem",
"manufacturer_name": "other",
"product_type_name": "Laptop",
"status_name": "Legal Hold",
"status_type_name": "Undeployable",
"asset_location": null,
"last_assignee": null
},
{
"id": 27565,
"asset_id": null,
"customer_asset_id": null,
"placed_on": "Jan 7, 2026",
"age_on_hold": "5 Days",
"serial_number": "LION-2-12-0",
"asset_name": "Laptop",
"manufacturer_name": "other",
"product_type_name": "Laptop",
"status_name": "Legal Hold",
"status_type_name": "Undeployable",
"asset_location": null,
"last_assignee": null
}
],
"current_page": 1,
"per_page": 10,
"total": 98,
"last_page": 10
}Error Responses
400 Bad Request
{
"success": false,
"message": "Invalid page number"
}401 Unauthorized
{
"success": false,
"message": "Invalid or missing authentication token"
}403 Forbidden
{
"success": false,
"message": "Insufficient permissions to view legal hold records"
}