growsurf_get_campaign_design
Retrieve the configured design fields for a GrowSurf program, including content, colors, sharing sections, and localized defaults. Target a specific campaign ID to access its design settings.
Instructions
Fetch the configured design fields for your GrowSurf program, including GrowSurf Window content, colors, sharing sections, landing/referred-friend content, participant sign-in copy under login, payout-destination confirmation page copy under payoutDestinationConfirmation, and country-name overrides under countryLabels. The confirmation section is omitted when no confirmation fields are stored. Stored null fields are returned as null; omitted and null fields use localized defaults. 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 |
|---|---|---|---|
| login | No | The returning-participant sign-in form plus its success, resend, validation, and error text. | |
| share | No | Share channels, invite settings, and share-button styling. | |
| stats | No | The participant's referral-progress stats panel. Only `title` is editable. | |
| theme | No | Visual theme styling (colors, shadows, and similar). | |
| header | No | Header content for participants (`postText`) and non-participants (`preText`). | |
| signup | No | Signup form fields, GDPR consent, and button and login text. | |
| window | No | Layout of the GrowSurf window (`navigationMode`: `TABS` or `LIST`). | |
| payouts | No | Affiliate programs only. The Payouts section of the participant portal. | |
| rewards | No | Heading, icon, and empty-state text of the rewards panel. | |
| commissions | No | Affiliate programs only. The Commissions section of the participant portal. | |
| leaderboard | No | The leaderboard section: labels, selectors, and name masking. | |
| landingPages | No | Portal and landing pages: company info, `content`, `styles`, third-party script ids, and SEO meta tags. | |
| countryLabels | No | Participant-facing country-name overrides keyed by ISO 3166-1 alpha-2 code (for example `GB`). Each label replaces the default country name wherever participants pick a country, such as payout and tax forms. Overrides merge per code on `PATCH`; `null` (or the default name) restores a code's default. Only overridden codes are returned. | |
| referralStatus | No | The section listing who a participant invited and each invite's progress. | |
| referralSummary | No | Referral programs only. The participant's row of summary tiles (clicks, leads, referrals, rewards). | |
| affiliateSummary | No | Affiliate programs only. The affiliate's row of summary tiles (clicks, revenue, payouts). | |
| referredExperience | No | The banner and headline shown to a visitor who arrives through a referral link. | |
| participantSettings | No | The participant's account settings area (logout, PayPal and Wise payout confirmation/status messages, tax details). | |
| payoutDestinationConfirmation | No | Customizable text for the payout-destination confirmation page opened from payout integration cards. One shared set applies to every enabled payout provider. Provider-aware text may use `{{payoutProvider}}`; omitted and `null` fields use localized defaults. |