List all partners
list_partnersList all partners in a partner program, with filters for status, country, group, email, or search and options to sort and paginate results.
Instructions
List all partners for a partner program.
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_partners"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number for pagination. The first page is `1`. | |
| No | Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`. | ||
| search | No | A search query to filter partners by ID, name, email, company name, description, social platforms, or referral links. Partial matches are supported. | |
| status | No | A filter on the list based on the partner's `status` field. | |
| account | No | Exact configured private workspace profile label; not a tenant or provider account ID. | |
| country | No | A filter on the list based on the partner's `country` field. | |
| sort_by | No | The field to sort the partners by. The default is `totalSaleAmount`. | totalSaleAmount |
| group_id | No | A filter on the list based on the partner's `groupId` field. | |
| page_size | No | The number of items per page. | |
| tenant_id | No | Filter the partner list based on the partner's `tenantId`. The value must be a string. Combines with the other filters. | |
| sort_order | No | The sort order. The default is `desc`. | desc |