List Direct Mail Campaigns
GET
/post/direct-mail/campaigns
Post Direct Mail
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rest.clicksend.com/v3/post/direct-mail/campaigns'Response Response Example
{
"data": {
"current_page": 3,
"data": [
{
"_areas": [
{
"campaign_id": 34,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 34,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 34,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 34,
"custom_string": null,
"date_added": 1477040355,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 35,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 35,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 35,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 35,
"custom_string": null,
"date_added": 1477040625,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [],
"_total_quantity": 0,
"campaign_id": 37,
"custom_string": null,
"date_added": 1477040829,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 38,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 38,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 38,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 38,
"custom_string": null,
"date_added": 1477040843,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 39,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 39,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 39,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 39,
"custom_string": null,
"date_added": 1477275714,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 40,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 40,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 40,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 40,
"custom_string": "Custom String",
"date_added": 1477275760,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 42,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 42,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 42,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 42,
"custom_string": "Custom String",
"date_added": 1477276756,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 43,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 43,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 43,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 43,
"custom_string": "Custom String",
"date_added": 1477276830,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 49,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 49,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 49,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 49,
"custom_string": "Custom String",
"date_added": 1477279662,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 51,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 51,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 51,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 51,
"custom_string": "Custom String",
"date_added": 1477279949,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 52,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 52,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 52,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 52,
"custom_string": "Custom String",
"date_added": 1477280021,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 53,
"location_id": 1,
"price": "222.00",
"quantity": 100,
"status": null
},
{
"campaign_id": 53,
"location_id": 2,
"price": "222.00",
"quantity": 100,
"status": null
},
{
"campaign_id": 53,
"location_id": 3,
"price": "111.00",
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 53,
"custom_string": "Custom String",
"date_added": 1477280780,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 54,
"location_id": 1,
"price": "222.00",
"quantity": 100,
"status": null
},
{
"campaign_id": 54,
"location_id": 2,
"price": "222.00",
"quantity": 100,
"status": null
},
{
"campaign_id": 54,
"location_id": 3,
"price": "111.00",
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 54,
"custom_string": "Custom String",
"date_added": 1477281977,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 55,
"location_id": 1,
"price": "222.00",
"quantity": 100,
"status": "Queued"
},
{
"campaign_id": 55,
"location_id": 2,
"price": "222.00",
"quantity": 100,
"status": "Queued"
},
{
"campaign_id": 55,
"location_id": 3,
"price": "111.00",
"quantity": 50,
"status": "Queued"
}
],
"_total_quantity": "250",
"campaign_id": 55,
"custom_string": "Custom String",
"date_added": 1477284216,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": "Queued",
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 56,
"location_id": 1,
"price": "222.00",
"quantity": 100,
"status": "Scheduled"
},
{
"campaign_id": 56,
"location_id": 2,
"price": "222.00",
"quantity": 100,
"status": "Scheduled"
},
{
"campaign_id": 56,
"location_id": 3,
"price": "111.00",
"quantity": 50,
"status": "Scheduled"
}
],
"_total_quantity": "250",
"campaign_id": 56,
"custom_string": "Custom String",
"date_added": 1477284517,
"message_id": null,
"name": "My Campaign",
"schedule": 1477384503,
"status": "Scheduled",
"user_id": 1
}
],
"from": 31,
"last_page": 5,
"next_page_url": "https://rest.clicksend.com/v3/post/direct-mail/campaigns?page=4",
"per_page": 15,
"prev_page_url": "https://rest.clicksend.com/v3/post/direct-mail/campaigns?page=2",
"to": 45,
"total": 69
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your results."
}Request
None