canonical: https://jentic.com/apis/growthhero.io/growthhero # GrowthHero API Jentic publishes the only available OpenAPI specification for GrowthHero API, keeping it validated and agent-ready. GrowthHero is a referral, affiliate, and growth-tracking platform used by SaaS and e-commerce brands to run referral programmes and partner campaigns. The API exposes 5 public endpoints covering referral creation and lookup plus campaign listing and retrieval, authenticated with an X-API-Key header. It is intentionally lightweight: marketers and agents can register a referral, fetch referral status, and inspect which campaigns are active without a heavy SDK. ## For AI agents Create and look up referrals and list active campaigns inside GrowthHero referral and growth-tracking programmes. ## Scope Does not handle email marketing campaigns, payment processing, or full affiliate payout disbursement - use for referral creation, lookup, and campaign listing in GrowthHero only. ## Capabilities - Register a new referral against a GrowthHero campaign with an X-API-Key request - Retrieve a single referral by id to check its current status and attributed campaign - List referrals in the workspace to reconcile against an internal CRM or billing system - Enumerate active campaigns to find the right campaign id before creating a referral - Look up a single campaign's metadata to validate program rules before tracking partner activity ## Use cases ### Sign-up referral attribution Track new sign-ups back to the partner or customer who referred them. When a user completes a SaaS sign-up flow, the backend calls POST /referrals with the referrer code and customer details, and GrowthHero records the attribution against the right campaign. Later, GET /referrals/{id} confirms the status (pending, approved, paid) so finance can reconcile partner payouts. Authentication is a simple X-API-Key header. Example prompt: Call POST /referrals with the referrer_code and new customer email when a sign-up completes, then poll GET /referrals/{id} weekly until the status reaches paid. ### Affiliate program reconciliation Reconcile GrowthHero affiliate activity against an internal billing database by paging through GET /referrals on a schedule. The data flows into a finance warehouse so analysts can verify commissions match expected payouts and spot referrals stuck in pending status. Pairing this with GET /campaigns lets ops teams confirm each referral was attributed to a still-active campaign before they pay out. Example prompt: Page through GET /referrals nightly, join the results to the billing table, and flag any referral whose campaign is no longer listed in GET /campaigns. ### Campaign-aware in-product referral widgets Power an in-product referral widget that always shows the right campaign for the current user. The widget calls GET /campaigns at load time, picks the campaign matching the user's plan or geography, and posts new referrals to /referrals when the user shares a link. This avoids the common bug where customers refer friends to a paused campaign and lose attribution. Example prompt: Call GET /campaigns, pick the campaign matching the customer's tier, and call POST /referrals when the user clicks 'Invite a friend'. ### AI agent integration through Jentic Expose GrowthHero referral and campaign operations to an AI agent through Jentic so growth teams can ask questions like 'how many referrals did campaign X drive last week?' without writing SQL. The agent searches Jentic for the right intent, loads the operation schema, and executes it against api.growthhero.io. Jentic isolates the X-API-Key in its vault, so the agent never sees the raw key. Example prompt: Through Jentic, search 'list growthhero referrals', load the operation, and execute it for the configured workspace. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /referrals | List referrals in the workspace | | POST | /referrals | Create a new referral | | GET | /referrals/{id} | Retrieve a single referral by id | | GET | /campaigns | List active campaigns | | GET | /campaigns/{id} | Retrieve a single campaign by id | ## Key resources - **referrals** — Create, list, and retrieve referrals attributed to a campaign - **campaigns** — List campaigns and retrieve metadata for a single campaign id ## Why Jentic - **Setup:** Wiring the GrowthHero API by hand means setting the X-API-Key header on every call to api.growthhero.io and handling referral and campaign pagination and retries yourself. Through Jentic you install once, import GrowthHero from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** GrowthHero puts the referral and campaign id in the URL path (/referrals/{id}, /campaigns/{id}), so a rule can pin your agent to one referral or campaign for reads. You choose the operations it may call, so creating new referrals is not included unless you add it. - **Credential handling:** Your GrowthHero X-API-Key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a GrowthHero referral' or 'list GrowthHero campaigns', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **ReferralCandy API** — E-commerce referral and reward program platform - **Refersion API** — Affiliate marketing platform for e-commerce brands - **Everflow Affiliate API** — Partner marketing and affiliate tracking platform ## FAQ ### Why is there no official OpenAPI spec for GrowthHero API? GrowthHero does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call GrowthHero API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the GrowthHero API use? GrowthHero uses an X-API-Key header on every request. The key is generated in the GrowthHero dashboard and scoped to one workspace. Through Jentic the X-API-Key is stored encrypted in the vault and the agent receives only a scoped Jentic-mediated token. ### Can I create a new referral via the API? Yes. POST /referrals creates a referral attributed to a specified campaign. The endpoint expects the referrer code and new customer details in the request body and returns the created referral id, which can then be polled via GET /referrals/{id}. ### What are the rate limits for the GrowthHero API? The public spec does not document explicit rate limits. GrowthHero throttles at the platform level per workspace; back off on HTTP 429 responses and batch reconciliation jobs into off-peak windows. ### How do I list campaigns through Jentic? Install Jentic with pip install jentic, search for 'list growthhero campaigns', load the matching operation, and execute it. Jentic resolves the call to GET /campaigns and returns the active campaign list with their ids and metadata. ### How do I find the campaign a referral was attributed to? Call GET /referrals/{id} for the referral and read its campaign reference, then call GET /campaigns/{id} to load the full campaign metadata. This pair of calls is enough to reconcile any referral against the program rules in force when it was created. ### Can I limit what my agent is allowed to do with the GrowthHero API? Yes. Because you run Jentic One yourself, your own rules decide which GrowthHero operations the agent may call, so you can grant read-only access to GET /referrals, GET /referrals/{id}, GET /campaigns, and GET /campaigns/{id} while leaving POST /referrals off entirely unless you add it. Since GrowthHero puts the referral and campaign identifier in the URL path, a rule can also pin the agent to a single referral or campaign for reads. Your X-API-Key is stored once by your own instance and injected only when a permitted operation runs, so the agent never handles the raw key.