Coupontools Logo

API & Webhooks

Connect the Coupontools platform with your apps or web projects. The Coupontools REST API allows you to query meta-data about your account, campaigns, distribution, validations, and usage data.

Retrieve information from a campaign

Returns information of one specific campaign.
Base URL
# Parameter Input Description
1 client_id API client ID Can be found in your API documentation
2 client_secret API client secret Can be found in your API documentation
3 campaign ID from the campaign Can be found in the list of all campaigns. Example: cam_12345
4 show_usage_stats true or false Defaults to false, will add the total numer of custom validation codes en number of claimed custom codes
	$ch = curl_init();
	$url = "";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	$data = [
		'campaign' => "cam_123456"
	curl_setopt($ch, CURLOPT_URL, "$url");
	curl_setopt($ch, CURLOPT_POST, true);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($ch, CURLOPT_VERBOSE, true);
	curl_setopt($ch, CURLOPT_HTTPHEADER, [
		"X-Client-Id: $client_id",
		"X-Client-Secret: $client_secret",
		"Content-Type: application/json",
	curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
	$response = curl_exec($ch);
Example response
					"status": {
						"status": "OK"
					"coupon_info": {
						"ID": "cam_123456",
						"code": "abc123",
						"url": "",
						"status": "example",
						"subaccount": "",
						"name": "[NO NAME]",
						"title": "10% OFF",
						"subtitle": "On all pizzas",
						"description": "",
						"expirydate": "2018-08-12 11:19:00",
						"timezone": "UTC",
						"terms": "",
						"terms_short": "Example coupon;",
						"poweredby": "Your Company",
						"poweredbylink": "",
						"coupon_tags": "",
						"coupon_category": "1",
						"coupon_category_name": "",
						"logo_url": "",
						"banner1": "",
						"banner2": "",
						"banner3": "",
						"banner4": "",
						"banner5": "",
						"coupon_image": "",
						"locations": [
								"ID": "loc_12345",
								"company_name": "location",
								"company_email": "",
								"company_phone": "",
								"company_password": "123456789",
								"company_street": "",
								"company_zip": "",
								"company_city": "",
								"company_state": "",
								"company_country": "",
								"company_lat": "0.000000",
								"company_long": "0.000000",
								"company_hours": ""
						"amount": 20, (only calculated when show_usage_stats is true)
						"amount_claimed": 5, (only calculated when show_usage_stats is true)
						"amount_validated": 4, (only calculated when show_usage_stats is true)
						(following three are only shown when the campaign is configured to generate codes)
						"code_prefix": "ab_3_",
						"code_length": "20",
						"code_type": "numeric"
Possible errors
  • 200: Missing parameter: campaign
  • 301: Invalid character in parameter: campaign.
  • 502: Campaign ID not found.

  • Register now for a 7-days trial account

    Start using Coupontools today!

Great you're here! Cookies? Read our Privacy Policy. I accept