Recovery Details

Retrieve detailed information about a specific asset recovery.

GET
/api/v1/recover/campaign/employee/{recovery_id}

Description

Retrieve comprehensive details about a specific asset recovery, including employee information, items recovered, recovery status, and timestamps. This endpoint provides a complete view of a single recovery transaction.

Request

Headers

HeaderValueRequired
AuthorizationBearer <token>Yes

Path Parameters

ParameterTypeRequiredDescription
recovery_codestringYesUnique recovery code for the asset recovery

Response

Response Fields

FieldTypeDescription
campaign_numbernumberRelated campaign number
employeeobjectEmployee details with items and status
return_addressarrayCampaign return addresses
employee.recovery_idstringUnique recovery identifier
employee.itemsarrayItem list for this recovery
employee.statusstringCurrent recovery lifecycle status
employee.trackingarrayTracking and courier details
last_updatedobjectLast update timestamp

Notes

  • This endpoint provides granular details about a single asset recovery transaction using the unique recovery code.
  • The completed_at field will be null for recoveries that are still pending or in progress.
  • Use this endpoint to track the status and timeline of individual recovery operations.
  • The items_recovered count reflects the total number of assets successfully retrieved from the employee.
  • Recovery codes are generated when employees are added to a campaign via the Bulk Upload endpoint.

Related Endpoints

Did this page help you?