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 users from a loyalty card
Returns a list of all users from a loyalty card.Base URL
POST: https://api4coupons.com/v3/loyaltyusers/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 | loyaltycard | ID from the loyaltycard | Can be found in the list of all loyalty cards. |
Required
|
<?php $ch = curl_init(); $url = "https://api4coupons.com/v3/loyaltyusers/list"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ 'loyaltycard' => "loy_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" }, "loyaltycard": [ { "ID": "loy_123456", "code": "abc123", "url": "https://loyaltycard.mobi/ac/abc123", "status": "active", "name": "Your loyalty card", "type": "stampcard", "amount_of_stamps": "8" } "amount_of_users": "1" "users": [ { "ID": "lus_123456", "first_name": "John", "last_name": "Doe", "gender": "male", "age_range": "", "profile_picture": "https://loyaltycard.mobi/uploads/foto.png", "email": "john@doe.com", "phone": "", "social_type": "Google", "stamps": "2", "subscribed_for_marketing": "1" } ] }