ghl_affiliate_list
Retrieve and filter affiliates for a location by name, email, active status, date range, or campaign, with pagination to page through full result sets.
Instructions
List Affiliates Retrieve the list of affiliates for a location. Endpoint: GET /affiliate-manager/{locationId}/affiliates (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_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Number of records to skip for pagination | |
| limit | No | Maximum number of records to return. Maximum allowed value is 100. A value of 0 is treated as the default of 10. | |
| query | No | Search affiliates by name or email | |
| active | No | Filter affiliates by active status | |
| toDate | No | Filter affiliates created on or before this date (YYYY-MM-DD) | |
| fromDate | No | Filter affiliates created on or after this date (YYYY-MM-DD) | |
| campaignId | No | Filter affiliates by campaign ID | |
| locationId | Yes | Location Id |