Get Legal Hold by ID

Retrieve details for a single active legal hold asset.

GET
/api/v1/legal-hold/{id}

Description

Returns asset and hold metadata for a manage_app_assets record currently in Legal Hold status.

Request

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Path Parameters

ParameterTypeRequiredDescription
idstringYesPass the full value from the API response in path parameters.

Response

FieldTypeDescription
successbooleanWhether the request succeeded.
messagestringHuman-readable status message.
dataobjectLegal hold asset details.
data.idstringOpaque asset record ID.
data.asset_idstringInternal asset identifier.
data.customer_asset_idstringCustomer asset ID.
data.placed_onstringDate the hold was placed (formatted).
data.age_on_holdstringDuration on hold (e.g. 3 Days).
data.serial_numberstringDevice serial number.
data.asset_namestringProduct or model name.
data.manufacturer_namestringManufacturer name.
data.product_type_namestringProduct type (e.g. Laptop).
data.status_namestringCurrent status name (Legal Hold).
data.status_type_namestringStatus type label (e.g. Undeployable).
data.status_type_idnumberStatus type ID.
data.asset_locationstringAsset location name.
data.last_assigneestringLast assigned employee name.
data.ticket_existsbooleanWhether a related ticket exists.
data.ticket_infoobject | nullRelated ticket details when ticket_exists is true.

Related Endpoints

Did this page help you?