Get Program
growsurf_get_campaignFetch GrowSurf campaign (program) details by ID or fallback environment variable to review configuration and reward settings for referral management.
Instructions
Fetch your GrowSurf campaign (program) details via REST. Embedded reward settings do not establish that an individual reward was earned, approved, or delivered. Earned reward records belong to the individual participant. Targets campaignId if supplied, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 |
|---|---|---|---|
| id | No | The program's unique id. | |
| name | No | The program name (internal only, never shown to participants). | |
| type | No | The program type. | |
| status | No | The program status. | |
| rewards | No | The program's reward configs (`CampaignReward`). Item shape is documented on the `growsurf_list_campaign_rewards` tool. | |
| currencyISO | No | The program currency as an ISO 4217 code (e.g. `USD`). | |
| inviteCount | No | Total invites sent by participants. | |
| winnerCount | No | Participants with at least one approved reward. | |
| referralCount | No | Total referrals. | |
| rewardEvidence | No | What this response establishes about rewards. Combine with other reads; unknown here does not override evidence elsewhere. | |
| impressionCount | No | Total referral-link views across participants. | |
| participantCount | No | Total participants. |