List Coupons

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

READghl.list_coupons

• Contract tier: agent_ready
• Risk: read
• Catalog version: 2026-07-12.2
• Descriptor hash: 95c517afaaa0e7b484ab6e735e883d8b21f97f21156b2cacba7e08816fcac260

List all coupons for the authenticated GHL location with optional filtering. The MCP injects the runtime location when altId is omitted. GHL category: Payments. This is a read-only GHL API operation.

Request Body

{
  "jsonrpc": "2.0",
  "id": "ghl-list-coupons-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.list_coupons",
    "arguments": {
      "altId": "altId_123",
      "limit": 1,
      "offset": 1,
      "search": "search_example",
      "status": "scheduled",
      "altType": "location",
      "tenantId": "tenantId_123"
    }
  }
}

Arguments Schema

{
  "type": "object",
  "required": [],
  "properties": {
    "altId": {
      "type": "string",
      "description": "Optional location ID. If provided, it must match the authenticated runtime location."
    },
    "limit": {
      "type": "number",
      "default": 100,
      "description": "Maximum number of coupons to return"
    },
    "offset": {
      "type": "number",
      "default": 0,
      "description": "Number of coupons to skip for pagination"
    },
    "search": {
      "type": "string",
      "description": "Search term to filter coupons by name or code"
    },
    "status": {
      "enum": [
        "scheduled",
        "active",
        "expired"
      ],
      "type": "string",
      "description": "Filter coupons by status"
    },
    "altType": {
      "enum": [
        "location"
      ],
      "type": "string",
      "description": "Alt Type. Defaults to location."
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant ID from list_tenants."
    }
  }
}

Output Schema

{
  "type": "object",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the GHL MCP operation completed successfully."
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Tool-specific GHL or local navigation result when ok is true."
    },
    "meta": {
      "type": "object",
      "description": "Safe execution, routing, and timing metadata.",
      "additionalProperties": true
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe error details when ok is false; credential values are never returned."
    }
  },
  "description": "Normalized GHL MCP response envelope.",
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "ghl-list-coupons-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.list_coupons",
    "arguments": {
      "altId": "altId_123",
      "limit": 1,
      "offset": 1,
      "search": "search_example",
      "status": "scheduled",
      "altType": "location",
      "tenantId": "tenantId_123"
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "ghl-list-coupons-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.list_coupons",
    "arguments": {
      "altId": "altId_123",
      "limit": 1,
      "offset": 1,
      "search": "search_example",
      "status": "scheduled",
      "altType": "location",
      "tenantId": "tenantId_123"
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "ghl-list-coupons-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.list_coupons",
    "arguments": {
      "altId": "altId_123",
      "limit": 1,
      "offset": 1,
      "search": "search_example",
      "status": "scheduled",
      "altType": "location",
      "tenantId": "tenantId_123"
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool ghl.list_coupons executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}