Get Campaign List

curl --request GET \
  --url https://api.campaigncleaner.com/v1/get_campaign_list

{
  "campaign_list": [
    {
      "id": "e8c8af95-c033-11ed-9848-003048d8d536",
      "campaign_name": "Test Campaign 1",
      "status": "completed",
      "date_added": "2023-02-23T12:02:46-05:00"
    },
    {
      "id": "a8c8af95-c033-11ed-9848-003048d8d537",
      "campaign_name": "Test Campaign 2",
      "status": "completed",
      "date_added": "2023-02-25T22:26:15-05:00"
    }
  ]
}

API Endpoints

Get Campaign List

The get_campaign_list API endpoint allows you to get the status of all the campaigns you have saved on Campaign Cleaner.

Header:

X-CC-API-Key: Your API Key

Response:

campaign_list:

id: The campaign id that will be used in other API calls.
campaign_name: The name of the campaign.
status: The status will be either processing, completed, or paused
date_added: The date and time your campaign was saved or submitted to Campaign Cleaner.

If the status is completed, you will be able to retrieve the campaign via the get_campaign API

In the event of an error, you will get an “error:” response, with a description of the reason

GET

get_campaign_list

Get Campaign List

curl --request GET \
  --url https://api.campaigncleaner.com/v1/get_campaign_list

{
  "campaign_list": [
    {
      "id": "e8c8af95-c033-11ed-9848-003048d8d536",
      "campaign_name": "Test Campaign 1",
      "status": "completed",
      "date_added": "2023-02-23T12:02:46-05:00"
    },
    {
      "id": "a8c8af95-c033-11ed-9848-003048d8d537",
      "campaign_name": "Test Campaign 2",
      "status": "completed",
      "date_added": "2023-02-25T22:26:15-05:00"
    }
  ]
}

Headers

X-CC-API-Key

string

Response

200 - application/json

The response is of type object.

Delete Campaign Get Campaign Status

API Reference

Headers

Response