Get Program Installation
growsurf_get_campaign_installationFetch the Installation tab configuration for a GrowSurf program to review embed, installation, and tracking settings, returning all fields and current values for updates.
Instructions
Fetch the Installation tab configuration for your GrowSurf program (embed/installation and tracking setup). Returns the full object with every field and its current value — the same shape you send back on update. 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 |
|---|---|---|---|
| mobile | No | GrowSurf iOS and Android SDK settings. | |
| signup | No | Custom signup-form settings (used with `FORM_DETECTION`). | |
| shareUrl | No | The landing page referred friends reach from a referral link. Set this before adding other origins to `allowedUrls`. | |
| allowedUrls | No | Every additional browser origin where the GrowSurf Window or SDK may run, including development origins such as `http://localhost:3000`. Preserve the full array when patching it. An origin absent from both `shareUrl` and this list can return `403`. Known shared-platform root domains, such as `github.io`, do not grant access. Add your site's hostname, such as `https://piedpiper.github.io`, or a domain you own. Path-based shared hosts, such as `unbouncepages.com`, require a domain you own. | |
| signupEvent | No | The signup tracking method: automatic form detection, or participants added via the SDKs and REST API. | |
| referralTrigger | No | Referral programs only. `ON_SIGNUP` counts a referral as soon as the friend signs up; `CUSTOM` also requires a qualifying action. | |
| instructionSelections | No | Saved choices shown in the Program Editor installation guide. | |
| useGrowSurfHostedLinks | No | Use GrowSurf-hosted referral links that route clicks by the visitor's device. Mainly for mobile apps. |