Campaign Details
Retrieve detailed information about a specific recovery campaign.
GET
/api/v1/recover/campaign/:campaign_numberDescription
Retrieve comprehensive details about a specific recovery campaign, including campaign metadata, employee information, recovery codes, and campaign status. This endpoint provides a complete view of all activities and participants within a campaign.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <token> | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign_number | number | Yes | Unique identifier of the recovery campaign |
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| campaign_number | number | Campaign identifier |
| title | string | Campaign title |
| country | object | Campaign country object with name and code |
| start_date | string | Campaign start date |
| helpdesk_email | string | null | Helpdesk contact email if configured |
| return_address | array | Return address details for the campaign |
| employees | array | Employee list included in campaign |
| total_employees | number | Total employee count |
| total_pages | number | Total number of pages |
| current_page | number | Current page number |
Notes
- This endpoint provides comprehensive details about a campaign including all employees and their recovery status.
- The employees array contains full details for each participant, including their recovery code and current status.
- Use this endpoint to monitor campaign progress and identify which employees have completed recovery vs. those still pending.
- For individual employee recovery details, use the Recovery Details endpoint with the specific recovery_code.
Related Endpoints
Did this page help you?
Request
curl -X GET https://dev-api.unduit.com/api/v1/recover/campaign/6720250912001 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response (200)
{
"campaign_number": "17458430682853",
"title": "Rolling Campaign for Desktops",
"country": {
"name": "France",
"code": "FR"
},
"start_date": "Apr 28th, 2025",
"helpdesk_email": null,
"return_address": [
{
"name": "John Doe",
"title": "Rolling Campaign for Desktops",
"company": "xxxxx",
"country": {
"name": "France",
"code": "FR"
},
"state": null,
"city": "xxxx",
"zip_code": "xxxx",
"address": "xxxxx",
"phone": "xxxxxxxx",
"email": "xxxxxxxx",
"packages": [
{
"device": "Laptop",
"qty": 1,
"incoming_weight": 10,
"length": 16,
"width": 12,
"height": 4
},
{
"device": "Monitor 32\"",
"qty": 1,
"incoming_weight": 30,
"length": 30,
"width": 30,
"height": 12
}
],
"campaign_countries": [
"DE",
"NL",
"IT",
"NO",
"PL",
"EE",
"DK"
]
}
],
"employees": [
{
"recovery_id": "174584241251583",
"email": "xxxxxx",
"firstname": "John",
"lastname": "Doe",
"phone_country": "FR",
"phone_number": "xxxxxxx",
"country": {
"name": "France",
"code": "FR"
},
"state": {
"name": "Paris",
"code": "PR",
"country_code": "FR"
},
"city": "paris",
"zip": "xxxx",
"address_line_1": "xxxxxxxx",
"address_line_2": "xxxxxxxxx",
"items": [
{
"item": "Laptop",
"item_serial_no": null,
"item_asset_id": null,
"item_imei": null,
"custom_field_1": null,
"custom_field_2": null,
"intake_status": "Received"
},
{
"item": "Desktop",
"item_serial_no": null,
"item_asset_id": null,
"item_imei": null,
"custom_field_1": null,
"custom_field_2": null,
"intake_status": "Received"
},
{
"item": "iphone",
"item_serial_no": null,
"item_asset_id": null,
"item_imei": null,
"custom_field_1": null,
"custom_field_2": null,
"intake_status": "Received"
},
{
"item": "Apple iPhone 14 Pro Max",
"item_serial_no": null,
"item_asset_id": null,
"item_imei": null,
"custom_field_1": null,
"custom_field_2": null,
"intake_status": "Received"
},
{
"item": "Apple iPhone 15 Pro Max",
"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": [
{
"carrier_name": "ups",
"forward_shipping": {
"tracking_number": "xxxxxxxx",
"tracking_link": "null"
},
"return_shipping": {
"tracking_number": "xxxxxxxxxx",
"tracking_link": "https://www.apps.ups.com/WebTracking/processRequest?HTMLVersion=5.0&Requester=NES&loc=en_US&tracknum=xxxxxxxx"
}
},
{
"carrier_name": "ups",
"forward_shipping": {
"tracking_number": "",
"tracking_link": null
},
"return_shipping": {
"tracking_number": "xxxxxxxxx",
"tracking_link": "https://www.apps.ups.com/WebTracking/processRequest?HTMLVersion=5.0&Requester=NES&loc=en_US&tracknum=xxxxxx"
}
}
],
"last_updated": "Apr 28th, 2025"
}
],
"total_employees": 2,
"total_pages": 1,
"current_page": 1
}