Recovery Details
Retrieve detailed information about a specific asset recovery.
GET
/api/v1/recover/recovery/:recovery_codeDescription
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
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <token> | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| recovery_code | string | Yes | Unique recovery code for the asset recovery |
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| recovery | object | Recovery details object |
| recovery.recovery_code | string | Unique recovery code |
| recovery.campaign_number | number | Associated campaign identifier |
| recovery.employee | object | Employee information object |
| recovery.employee.email | string | Employee email address |
| recovery.employee.firstname | string | Employee first name |
| recovery.employee.lastname | string | Employee last name |
| recovery.status | string | Recovery status (pending, in_progress, completed) |
| recovery.items_recovered | number | Number of items recovered |
| recovery.created_at | string | ISO 8601 timestamp when recovery was initiated |
| recovery.completed_at | string | ISO 8601 timestamp when recovery was completed (null if pending) |
Error Responses
Common error responses you may encounter when using this endpoint.
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?
Request
curl -X GET https://dev-api.unduit.com/api/v1/recover/recovery/REC-2024-001 \
-H "Authorization: Bearer <token>"Success Response (200)
{
"success": true,
"recovery": {
"recovery_code": "REC-2024-001",
"campaign_number": 6720250912001,
"employee": {
"email": "jane.doe@example.com",
"firstname": "Jane",
"lastname": "Doe"
},
"status": "completed",
"items_recovered": 2,
"created_at": "2025-09-12T10:30:00Z",
"completed_at": "2025-09-12T14:45:00Z"
}
}Error Responses
400 Bad Request
{
"success": false,
"message": "Invalid recovery_code format"
}401 Unauthorized
{
"message": "Invalid or expired token"
}404 Not Found
{
"success": false,
"message": "Recovery not found"
}