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 a list of registered users from a directory

Returns a list of users that have registered for a directory.

CAUTION: The API call response returns the registrations in a reverse-chronologically ordered array limited to max. 100 registrations. Use the "page" parameter in order to retrieve "older" registrations.
Base URL
POST: https://api4coupons.com/v3/directoryusers/list
Parameters
# Parameter Input Description
1 client_id API client ID Can be found in your API documentation
Required
2 client_secret API client secret Can be found in your API documentation
Required
3 directory ID from the directory Can be found in the list of all directories.
Required
4 page Page number Defaults to 1. Page is limited to 100 registrations.
Optional
<?php
	$ch = curl_init();
	$url = "https://api4coupons.com/v3/directoryusers/list";
	$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": "dir_12345",
			"subaccount": "",
			"amount_of_users": "1",
			"page": "1",
			"users": [
				{
					"ID": "reg_12345",
					"last_seen": "2025-01-01 13:48:22 UTC",
					"amount_of_logins": "1",
					"email": "info@clientemail.com",
					"phone": "",
					"first_name": "John",
					"last_name": "Johnson",
					"gender": "male",
					"birthday": "1970-01-01",
					"age_range": "21",
					"payment_status": "",
					"payment_confirmation_id": "",
					"payment_confirmation_account": ""
				}
			]
		}
		
Possible errors
  • 301: Invalid character in parameter: directory.
  • 507: Directory ID not found.

  • Inscrivez-vous pour un compte d'essai de 7 jours

    Commencez à utiliser Coupontools dès aujourd'hui !

C'est bien que vous soyez ici ! Des cookies ? Lisez notre déclaration de confidentialité. J'accepte
x