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

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
campaign_number	number	Related campaign number
employee	object	Employee details with items and status
return_address	array	Campaign return addresses
employee.recovery_id	string	Unique recovery identifier
employee.send_notifications_to	string	Where recovery email and SMS updates are sent: work or personal
employee.work_email	string \| null	Employee work email address
employee.personal_email	string \| null	Employee personal email address
employee.work_phone	string \| null	Employee work phone number
employee.personal_phone	string \| null	Employee personal phone number
employee.work_phone_country	string \| null	ISO country code for the work phone
employee.personal_phone_country	string \| null	ISO country code for the personal phone
employee.email	string \| null	Legacy alias of work_email. Same value. Prefer work_email
employee.phone_number	string \| null	Legacy alias of work_phone. Same value. Prefer work_phone
employee.phone_country	string \| null	Legacy alias of work_phone_country. Same value. Prefer work_phone_country
employee.items	array	Item list for this recovery
employee.status	string	Current recovery lifecycle status
employee.tracking	array	Tracking and courier details
last_updated	object	Last 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

Campaign List

Get all recovery campaigns

Campaign Details

Get details about a specific campaign

Did this page help you?

Request

curl -X GET https://dev-api.unduit.com/api/v1/recover/campaign/employee/174799688552242 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json"

Success Response (200)

{
    "campaign_number": "17479867492936",
    "title": "multi count camp",
    "country": {
        "name": "Germany",
        "code": "DE"
    },
    "start_date": "May 23rd, 2025",
    "helpdesk_email": null,
    "return_address": [
        {
            "name": "Arne Klewitz",
            "title": "multi count camp",
            "company": "Myplace Storage Abteil No. 2128",
            "country": {
                "name": "Germany",
                "code": "DE"
            },
            "state": {
                "name": "Rhineland-Palatinate",
                "code": "RP",
                "country_code": "DE"
            },
            "city": "Mainz",
            "zip_code": "55122",
            "address": "Anni-Eisler-Lehmann-Strasse 7",
            "phone": "2435345345345",
            "email": "[email protected]",
            "packages": [
                {
                    "device": "Laptop",
                    "qty": 1,
                    "incoming_weight": 10,
                    "length": 16,
                    "width": 12,
                    "height": 4
                }
            ],
            "campaign_countries": [
                "DE",
                "NL",
                "IT",
                "NO",
                "PL",
                "EE",
                "DK"
            ]
        }
    ],
    "employee": {
        "recovery_id": "174799688552242",
        "firstname": "Germany",
        "lastname": "address",
        "send_notifications_to": "work",
        "work_email": "[email protected]",
        "personal_email": null,
        "work_phone": "98257825973",
        "personal_phone": null,
        "work_phone_country": "US",
        "personal_phone_country": null,
        "email": "[email protected]",
        "phone_number": "98257825973",
        "phone_country": "US",
        "country": {
            "name": "Germany",
            "code": "DE"
        },
        "state": {
            "name": "Baden-Württemberg",
            "code": "BW",
            "country_code": "DE"
        },
        "city": "Stuttgart",
        "zip": "70597",
        "address_line_1": "Chemnitzer Strasse 13",
        "address_line_2": "",
        "items": [
            {
                "item": "Laptop testing recovery multi",
                "item_serial_no": null,
                "item_asset_id": null,
                "item_imei": null,
                "custom_field_1": null,
                "custom_field_2": null,
                "intake_status": "Received"
            }
        ],
        "status": "Order Received",
        "tracking": [],
        "last_updated": "May 23rd, 2025"
    }
}