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 categories.
Retrieves a list of all available categories.Base URL
POST: https://api4coupons.com/v3/category/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 |
<?php $ch = curl_init(); $url = "https://api4coupons.com/v3/category/list"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ ]; 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" }, "categories": { "0": "Other", "1": "Automotive", "2": "Baby & Kid", "3": "Books, Music & Movies", "4": "Beverages", "5": "Clothing & Shoes", "6": "Electronics", "7": "Foods", "8": "Gifts", "9": "Grocery", "10": "Health Care", "11": "Home & Garden", "12": "Services", "13": "Sport & Hobbies", "14": "Travel", "15": "Bars, Pubs & Night Clubs", "16": "Play, Donate and Win", "17": "Dining", "18": "Shopping", "19": "Transportation", "20": "Attractions", "21": "Online offers", "23": "Casinos, Gaming", "24": "Beauty, Spas", "25": "Fitness", "26": "Events" } }
Possible errors
- 200: Missing parameter: directory
- 301: Invalid character in parameter: directory.
- 507: Directory ID not found.