Get Program Design
growsurf_get_campaign_designFetch the configured design and copy settings for a GrowSurf campaign to inspect or reuse its window content, colors, sharing, avatars, widget, login, payout, traffic, and participant settings.
Instructions
Fetch the configured design fields for your GrowSurf program, including GrowSurf Window content, colors, sharing sections, participant avatars under participantAvatarStyle, referred-visitor content such as the Claim Offer Popup, the website widget under widget, the participant Traffic report under trafficInsights (it starts on for new affiliate programs and hidden for referral programs, and every setting is returned with its default copy), participant sign-in copy under login, payout-destination confirmation page copy under payoutDestinationConfirmation, country-name overrides under countryLabels, and the participant Settings panel under participantSettings (its languageSectionTitle and languageSectionInstructionsText label the language picker shown when the program has more than one language). participantAvatarStyle is CHARACTERS, INITIALS, ANIMALS, or GRADIENT; missing or unknown values mean INITIALS. 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 | Yes | 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 |
|---|---|---|---|
| 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. | |
| widget | No | The website widget — the invite that sits in a corner of the customer's own site. It renders as a button or as a card, and its card folds back into the button when a visitor closes it. Both audience switches start off, so a program shows nothing until one is turned on. | |
| 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. | |
| resources | No | Participant Resources presentation settings: visibility, title, link and copy labels, the message shown when nothing is published, and the section icon. Resource items use the program Resource tools. | |
| 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. `revealInviteEmails` lets a signed-in participant see original invitation addresses when disclosure permission was recorded. Private invites and full email masking keep addresses hidden. Other referral addresses stay masked. `revealInviteEmailText` supplies the sign-in prompt; `loadErrorMessage` is shown when the list cannot load; `followUp` supplies the invitation follow-up labels and messages. | |
| referralSummary | No | Referral programs only. The participant's row of summary tiles (clicks, leads, referrals, rewards). | |
| trafficInsights | No | The Traffic report participants can open from the GrowSurf window: visits to their share link over time and where those visits came from. It starts on for new affiliate programs and hidden for referral programs. Every setting is returned, with the default copy for anything not changed. Labels cannot be blank. | |
| affiliateSummary | No | Affiliate programs only. The affiliate's row of summary tiles (clicks, revenue, payouts). | |
| referredExperience | No | The banner, headline, and Claim Offer Popup shown to a visitor who arrives through a referral link. The popup is available for referral and affiliate programs. | |
| participantSettings | No | The participant's account settings area (logout, language picker, PayPal and Wise payout confirmation/status messages, tax details). `languageSectionTitle` and `languageSectionInstructionsText` (up to 500 characters each) are the title and help text of the language row, shown when the program has more than one language. `taxSection.instructionsText` and `taxSection.residencyLabel` show when tax forms are required; `taxSection.vatOnlyInstructionsText` and `taxSection.vatOnlyResidencyLabel` show instead when an affiliate program collects VAT numbers without requiring tax forms. | |
| participantAvatarStyle | No | How participant avatars appear in the GrowSurf Window. New programs use `CHARACTERS`; missing or unknown stored values return `INITIALS`. | |
| 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. |