growsurf_get_campaign
Fetch GrowSurf campaign details by ID, or default to your configured campaign. Use to inspect or configure a referral program.
Instructions
Fetch your GrowSurf campaign (program) details via REST. Targets campaignId if you pass it, 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. Pass the `id` returned by growsurf_create_campaign to configure or operate a program you just created, 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. | |
| impressionCount | No | Total referral-link views across participants. | |
| participantCount | No | Total participants. |