List Participants
growsurf_list_participantsList participants in a GrowSurf program, newest first, using paging and exact metadata filters to find or track participants by your own IDs.
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| nextId | No | Participant ID returned as `nextId` from the previous page. | |
| metadata | No | Exact-match filter on participant metadata, up to 3 keys, for example `{ "customerId": "12345" }`. Values compare as strings. | |
| campaignId | No | Target program (campaign) id for this call. 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. |