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 | string | Yes | Unique identifier of the recovery campaign |
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| campaign | object | Campaign details object |
| campaign.campaign_number | number | Unique identifier for the campaign |
| campaign.campaign_name | string | Name of the campaign |
| campaign.campaign_status | string | Current status (active, completed) |
| campaign.created_at | string | Campaign creation date |
| campaign.total_employees | number | Total number of employees in the campaign |
| campaign.total_recovered | number | Number of assets successfully recovered |
| campaign.total_pending | number | Number of pending recoveries |
| campaign.employees | array | Array of employee objects in the campaign |
| campaign.employees[].email | string | Employee email address |
| campaign.employees[].firstname | string | Employee first name |
| campaign.employees[].lastname | string | Employee last name |
| campaign.employees[].recovery_code | string | Unique recovery code for the employee |
| campaign.employees[].status | string | Recovery status (pending, completed) |
Error Responses
Common error responses you may encounter when using this endpoint.
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>"Success Response (200)
{
"success": true,
"campaign": {
"campaign_number": 6720250912001,
"campaign_name": "Q4 2025 Asset Recovery",
"campaign_status": "active",
"created_at": "2025-09-12",
"total_employees": 45,
"total_recovered": 38,
"total_pending": 7,
"employees": [
{
"email": "jane.doe@example.com",
"firstname": "Jane",
"lastname": "Doe",
"recovery_code": "REC-2024-001",
"status": "completed"
}
]
}
}Error Responses
400 Bad Request
{
"success": false,
"message": "Invalid campaign_number format"
}401 Unauthorized
{
"message": "Invalid or expired token"
}404 Not Found
{
"success": false,
"message": "Campaign not found"
}