list_members
Fetch paginated patron lists for a Patreon campaign, with cursor pagination and optional fields like user profile, email, tiers, address, or private notes.
Instructions
List patrons for a campaign with cursor pagination.
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_members"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | next_cursor from a previous list_members call. | |
| page_size | No | Results per page (1-1000). | |
| campaign_id | No | Campaign ID. Omit only when the token can see exactly one campaign. | |
| include_note | No | Include the creator's private note about each patron. | |
| include_user | No | Include the patron's public user profile. | |
| include_email | No | Include patron email addresses. Requires PATREON_ALLOW_PII=1 and the campaigns.members[email] scope; patrons may hide it. | |
| include_tiers | No | Include the tiers each member is entitled to. | |
| include_address | No | Include shipping addresses. Requires PATREON_ALLOW_PII=1 and the campaigns.members.address scope; handle as sensitive data. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | No | ||
| members | No | ||
| next_cursor | No |