Campaign List
Retrieve a paginated list of all recovery campaigns.
GET
/api/v1/recover/campaignsDescription
Retrieve a paginated list of all recovery campaigns associated with your organization. Each campaign includes summary information such as campaign name, status, creation date, and recovery statistics.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <token> | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | No | Page number for pagination (default: 1) |
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| campaigns | array | Array of campaign objects |
| campaigns[].campaign_number | number | Unique identifier for the campaign |
| campaigns[].campaign_name | string | Name of the campaign |
| campaigns[].campaign_status | string | Current status (active, completed) |
| campaigns[].created_at | string | Campaign creation date |
| campaigns[].total_employees | number | Total number of employees in the campaign |
| campaigns[].total_recovered | number | Number of assets successfully recovered |
| campaigns[].total_pending | number | Number of pending recoveries |
| current_page | number | Current page number |
| total_pages | number | Total number of pages available |
| total_campaigns | number | Total number of campaigns across all pages |
Error Responses
Common error responses you may encounter when using this endpoint.
Notes
- Results are paginated with a default page size. Use the page parameter to navigate through multiple pages of campaigns.
- Campaign statistics (total_employees, total_recovered, total_pending) provide a quick overview of campaign progress.
- For detailed information about a specific campaign, including employee lists, use the Campaign Details endpoint.
- Campaigns are returned in reverse chronological order, with the most recently created campaigns appearing first.
Related Endpoints
Did this page help you?
Request
curl -X GET https://dev-api.unduit.com/api/v1/recover/campaigns?page=1 \
-H "Authorization: Bearer <token>"Success Response (200)
{
"success": true,
"campaigns": [
{
"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
},
{
"campaign_number": 6720250812001,
"campaign_name": "Q3 2025 Asset Recovery",
"campaign_status": "completed",
"created_at": "2025-08-12",
"total_employees": 32,
"total_recovered": 32,
"total_pending": 0
}
],
"current_page": 1,
"total_pages": 5,
"total_campaigns": 45
}Error Responses
400 Bad Request
{
"success": false,
"message": "Invalid page number"
}401 Unauthorized
{
"message": "Invalid or expired token"
}