ghl_affiliate_payout_list
Retrieve affiliate payouts for a location with date, status, campaign, and affiliate filters, plus pagination to page through results.
Instructions
List Payouts Retrieve the list of payouts for a location. Endpoint: GET /affiliate-manager/{locationId}/payouts (Version header: v3; source: v3/affiliate-manager-v3.json) OAuth scopes: affiliate-manager.readonly Pagination params: skip, limit — 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": {
"locationId": "<locationId>"
},
"name": "ghl_affiliate_payout_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Filter payouts on or before this date (ISO 8601) | |
| skip | No | Number of records to skip for pagination | |
| limit | No | Maximum number of records to return | |
| query | No | query | |
| start | No | Filter payouts on or after this date (ISO 8601) | |
| status | No | Payout Status | |
| campaignId | No | Campaign Id | |
| locationId | Yes | Location Id | |
| affiliateId | No | Affiliate Id |