List Participants
growsurf_list_participantsLists participants in a GrowSurf program, newest page first, with paging via nextId and exact metadata or group filters to find specific people.
Instructions
List participants in your GrowSurf program, newest page first. limit is 1-100 (default 10). Pass response nextId into the next call to continue paging. Pass metadata to return only participants whose stored metadata matches every given key and value exactly, for example { "customerId": "12345" } to look someone up by your own customer ID; filtered results are ordered by participant ID. Results include participant IDs. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
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": {
"campaignId": "<campaignId>"
},
"name": "growsurf_list_participants"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| nextId | No | Participant ID returned as `nextId` from the previous page. | |
| groupId | No | Return only this group's members (`grp_…`). Works alone or with `metadata`. Default has no ID, so it cannot be named here. An ID that is not a group in this program returns `404`. | |
| metadata | No | Exact-match filter on participant metadata, up to 3 keys, for example `{ "customerId": "12345" }`. Values compare as strings. | |
| campaignId | Yes | Target program id for this call: the `id` returned by `growsurf_list_campaigns`, not the program name or a share URL. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of participants requested for this page. | |
| nextId | No | Participant id to pass as `nextId` for the next page, or `null` when there are no more results. | |
| participants | No | Participants returned for this page. | |
| rewardEvidence | No | What this response establishes about rewards. Combine with other reads; unknown here does not override evidence elsewhere. |