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.
-
Subaccount
- Retrieve a list of subaccounts
- Retrieve info of a subaccount
- Create a subaccount
- Update a subaccount
- Create password reset url for subaccount
- Single sign on for subaccounts
-
Campaign
- Retrieve a list of your campaigns
- Retrieve information from a campaign
- Retrieve all usage data from a campaign
- Retrieve all data from one coupon session
- Update data from a coupon session
- Update data from multiple coupon sessions
- Search coupon session
- Search coupon session from a campaign
- Send single push notification
- Send push notification to all
-
Loyalty Card
- Retrieve a list of your loyalty cards
- Retrieve a list of users from a loyalty card
- Update loyalty card user
- Send single push notification
- Send push notification to all
-
Directory
- Retrieve a list of your directories
- Retrieve information from a directory
- Retrieve all campaigns from a directory
- Retrieve registered users from a directory
- Update directory user payment status
- Retrieve a list of categories
- Retrieve a list of 3rd level categories
-
Single Use
- Create a single use access URL
- Create multiple single use access URLs
- Remove a single use access URL
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.