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 directory

Returns information of one specific directory.
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 directory ID from the directory Can be found in the list of all directories.
	$ch = curl_init();
	$url = "";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	$data = [
		'directory' => "dir_12345"
	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"
			"directory": {
				"ID": "dir_123456",
				"code": "3bnEPUtMPSXHz3YSBq4cg",
				"name": "directory name",
				"payment": {
					"currency": "USD",
					"amount": "10.00",
					"type": "recurring_monthly",
					"description": "This is a test payment"
Payment type information
Single payment => basic
Recurring daily payment => recurring_daily
Recurring weekly payment => recurring_weekly
Recurring monthly payment => recurring_monthly
Recurring yearly payment => recurring_yearly
Possible errors
  • 301: Invalid character in parameter: directory.
  • 507: Directory 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