Campaign List

Retrieve a paginated list of recover campaigns.

GET

/api/v1/recover/campaigns

Description

Retrieves a paginated list of Recover Campaigns associated with the company. By default, the response includes up to 10 campaigns per page.

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
campaigns	array	Array of campaign objects
campaigns[].campaign_number	number	Unique identifier for the campaign
campaigns[].campaign_title	string	Title of the campaign
campaigns[].country	array	Country list objects with name and code
campaigns[].start_date	string	Campaign start date
campaigns[].total_device_count	number	Total number of devices in campaign
campaigns[].total_employee	number	Total employees in campaign
total_records	number	Total campaign records
current_page	number	Current page number
total_pages	number	Total number of pages available

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

Campaign Details

Get details about a specific campaign

Initiate Recovery

Create a new recovery campaign

Did this page help you?

Request

curl -X GET https://dev-api.unduit.com/api/v1/recover/campaigns?page=1 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json"

Success Response (200)

{
  "total_records": 10,
  "total_pages": 1,
  "current_page": 1,
  "campaigns": [
    {
      "campaign_number": "17458430682853",
      "campaign_title": "Rolling Campaign for Desktops",
      "start_date": "Apr 28th, 2025",
      "country": [
        {
          "name": "France",
          "code": "FR"
        }
      ],
      "total_device_count": 120,
      "total_employee": 57
    },
    {
      "campaign_number": "17448093142852",
      "campaign_title": "Rolling Campaign for Network Devices",
      "start_date": "Apr 11th, 2025",
      "country": [
        {
          "name": "India",
          "code": "IN"
        }
      ],
      "total_device_count": 13,
      "total_employee": 5
    },
    {
      "campaign_number": "17448094992831",
      "campaign_title": "Rolling Campaign for MacBooks",
      "start_date": "Feb 5th, 2025",
      "country": [
        {
          "name": "India",
          "code": "IN"
        }
      ],
      "total_device_count": 14,
      "total_employee": 6
    },
    {
      "campaign_number": "17448094992829",
      "campaign_title": "UK Campaign",
      "start_date": "Feb 5th, 2025",
      "country": [
        {
          "name": "United Kingdom",
          "code": "GB"
        }
      ],
      "total_device_count": 7,
      "total_employee": 6
    },
    {
      "campaign_number": "17448094992654",
      "campaign_title": "Rolling Campaign for Printer",
      "start_date": "Oct 25th, 2023",
      "country": [
        {
          "name": "United States",
          "code": "US"
        }
      ],
      "total_device_count": 20,
      "total_employee": 5
    },
    {
      "campaign_number": "17448094992450",
      "campaign_title": "Rolling Campaign",
      "start_date": "Jan 27th, 2023",
      "country": [
        {
          "name": "United States",
          "code": "US"
        }
      ],
      "total_device_count": 8017,
      "total_employee": 3422
    },
    {
      "campaign_number": "17448094992391",
      "campaign_title": "Equipment Return - Corp",
      "start_date": "Dec 21st, 2022",
      "country": [
        {
          "name": "United States",
          "code": "US"
        }
      ],
      "total_device_count": 64,
      "total_employee": 25
    }
  ]
}