ghl_payment_coupon_list
Retrieves all coupons available in a GoHighLevel location, with pagination, search, and status filters to view promotional offers and discounts.
Instructions
List Coupons The "List Coupons" API allows you to retrieve a list of all coupons available in your location. Use this endpoint to view all promotional offers and special discounts for your customers. Endpoint: GET /payments/coupon/list (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/coupons.readonly Pagination params: limit, offset — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"altId": "<altId>",
"altType": "<altType>"
},
"name": "ghl_payment_coupon_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | Location Id | |
| limit | No | Maximum number of coupons to return | |
| offset | No | Number of coupons to skip for pagination | |
| search | No | Search term to filter coupons by name or code | |
| status | No | Filter coupons by status | |
| altType | Yes | Alt Type |