List Referrals
list_referralsList referrals for the current account, newest first, with each affiliate's name. Optional local-date bounds filter created_at; totals and pagination use the same window.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_referrals"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Filter by exact record ID. | |
| page | No | ||
| limit | No | ||
| state | No | Filter by conversion state. | |
| end_date | No | Inclusive local date upper bound for created_at. | |
| timezone | No | IANA time zone used to interpret the date bounds; defaults to UTC because accounts do not store a reporting time zone. | |
| start_date | No | Inclusive local date lower bound for created_at. Omit both dates for lifetime results. | |
| affiliate_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes |