ghl_affiliate_list_customers
Retrieve a paginated list of customers for an affiliate using a location ID, with optional filters for status, campaign, query, and commission status.
Instructions
List customers Retrieve the list of customers for an affiliate. Endpoint: GET /affiliate-manager/{locationId}/affiliates/{affiliateId}/customers (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. 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>",
"affiliateId": "<affiliateId>"
},
"name": "ghl_affiliate_list_customers"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Number of customers to skip | |
| limit | No | Number of customers to return, maximum 100 | |
| query | No | query | |
| status | No | Customer Type | |
| campaignId | No | Campaign Id | |
| locationId | Yes | Location Id | |
| affiliateId | Yes | Affiliate Id | |
| commissionStatus | No | Commission Status |