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 the email subscribers from a group

Returns a list of all the subscribers to a specific email group.
Base URL
POST: https://api4coupons.com/v3/emailtool/userlist
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 emailgroup ID of the email group Can be found in the Email Group list API endpoint.
Required
<?php
	$ch = curl_init();
	$url = "https://api4coupons.com/v3/emailtool/userlist";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	$data = [
		'emailgroup' => "gro_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"
			},
			"group_id": "gro_123456",
			"group_name": "Subscribers to pizza coupon",
			"amount_of_contacts": "2",
			"contact": [
				{
					"ID": "con_123456",
					"phone": "123456789012",
					"first_name": "John",
					"last_name": "Doe",
					"unsubscribed": "1"
				},
				{
					"ID": "con_1234567",
					"phone": "441234567890",
					"first_name": "Jeff",
					"last_name": "Jefferson",
					"unsubscribed": "0"
				}
			]
		}
		
Possible errors
  • 103: Your account is not connected with the Coupontools Email services
  • 200: Missing parameter: emailgroup
  • 301: Invalid character in parameter: emailgroup.
  • 514: Group ID not found in your account!

  • Regístrate ahora para una cuenta de prueba por 7 días

    ¡Empieza a usar Coupontools hoy!

¡Genial, estás aquí! ¿Cookies? Lee nuestrasPolíticas de Privacidad. Yo acepto
x