canonical: https://jentic.com/apis/api.growthhero.io/growthhero # GrowthHero API The GrowthHero API is a RESTful interface for managing affiliate and refer-a-friend programs. Agents can register and update partners, record orders that drive commissions, manage partner groups and tiered commission rules, run payout batches, and track subscription-driven recurring commissions. Each resource exposes list, retrieve, create, update, and balance-adjustment operations so an integrated app can run an end-to-end referral workflow without bespoke logic. ## For AI agents Manage affiliate and referral programs - register partners, attribute orders, run payout batches, and adjust partner balances - through a single REST interface. ## Scope Does not handle payment processing, email marketing, or product catalogue management - use for affiliate and refer-a-friend program operations only. ## Capabilities - Register affiliate partners with contact and payout details and update their profile fields - Attribute orders to partners so that commissions calculate against the correct referral - Run payout batches that aggregate partner balances across a defined period - Adjust an individual partner balance with a positive or negative correction - Group partners into tiers with shared commission rules and reporting - Track subscription-based recurring commissions tied to order IDs ## Use cases ### Affiliate Onboarding Automation Provision new affiliate accounts as they sign up on a partner portal or external form. The POST /partners endpoint creates the partner record with email, payout method, and metadata, returning the partner ID that can be embedded in unique referral links. Combined with PUT /partners/{id} for profile edits, an agent can run a fully automated onboarding flow without manual data entry. Example prompt: Call POST /partners with the new partner's email, name, and payout email, then return the created partner ID and referral URL. ### Commission Reconciliation Reconcile partner balances against external order data by listing partner transactions and applying balance adjustments where refunds, chargebacks, or manual corrections are needed. The /partners/{id}/transactions endpoint exposes the running ledger and /partners/{id}/adjust_balance applies a delta. Reconciliation cycles that previously took hours of spreadsheet work can run continuously on order webhook events. Example prompt: For partner ID 12345, list transactions in the last 30 days and POST /partners/12345/adjust_balance with -19.99 to claw back a refunded commission. ### Scheduled Payout Batches Run monthly or weekly payout batches that group eligible partners and trigger their generated payouts. The POST /partners/{id}/generate_payout endpoint creates a payout entry per partner; coordinator scripts can iterate over the partner list and generate payouts in bulk while respecting minimum thresholds set in the program. This replaces manual CSV exports to payment providers. Example prompt: List all partners, filter to those with a positive balance over $50, and call POST /partners/{id}/generate_payout for each one. ### AI Agent Referral Operations An AI agent running marketing operations can use GrowthHero through Jentic to attribute orders, audit balances, and generate payouts on demand. Jentic exposes the partner, order, and payout endpoints as discoverable tools so the agent picks the right operation by intent rather than reading the Apiary docs. The API key never leaves your Jentic One instance. Example prompt: Search for 'register an affiliate partner', load the POST /partners schema, and execute it for the partner detail provided in the agent input. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /partners | List affiliate partners | | POST | /partners | Create a new affiliate partner | | POST | /partners/{id}/generate_payout | Generate a payout for a partner | | POST | /partners/{id}/adjust_balance | Apply a balance correction to a partner | | GET | /partners/{id}/transactions | List a partner's commission transactions | | POST | /orders | Create an order attributed to a partner | | GET | /groups | List partner groups with their commission rules | ## Key resources - **Partners** — Affiliate partners with profile, balance, and transaction history - **Orders** — Orders attributed to partners that drive commission calculations - **Groups** — Logical groupings of partners with shared commission rules - **PayoutBatches** — Batch payouts that aggregate partner balances over a period - **Subscriptions** — Recurring orders attributed to partners for ongoing commissions ## Why Jentic - **Setup:** Wiring GrowthHero by hand means setting up its API key auth and coding your own calls to the partners, orders, and payout endpoints. Through Jentic you install once, import the GrowthHero API from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** GrowthHero puts the partner id in the URL path (/partners/{id}/generate_payout, /partners/{id}/adjust_balance, /partners/{id}/transactions), so a rule can pin your agent to one partner. You choose the operations it may call, so generating a payout or adjusting a balance are not included unless you add them. - **Credential handling:** Your GrowthHero 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 'list affiliate partners' or 'read a partner's transactions', and Jentic returns the matching GrowthHero operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Rewardful API** — Rewardful is a Stripe-native affiliate platform; GrowthHero is a more general affiliate and refer-a-friend platform - **Partnerize API** — Partnerize targets enterprise partner marketing across networks; GrowthHero targets SMB direct-to-merchant referral programs - **NetRefer Operator API** — NetRefer is an enterprise affiliate platform widely used in regulated verticals; GrowthHero is lighter-weight for direct merchants ## FAQ ### What authentication does the GrowthHero API use? GrowthHero uses an API key passed in a request header (apiKeyAuth scheme). When integrated through Jentic, the key is held encrypted in your Jentic One instance and attached to the request at execution time, so agent code does not handle the raw key. ### Can I generate affiliate payouts in bulk with the GrowthHero API? Yes. The API does not expose a single bulk-payout endpoint, but you can list partners with GET /partners, filter by balance, and call POST /partners/{id}/generate_payout for each eligible partner. Wrap the loop in your own scheduling job to run weekly or monthly cycles. ### What are the rate limits for the GrowthHero API? GrowthHero does not publish a hard rate limit in its OpenAPI spec; the documentation recommends keeping concurrent requests modest and contacting support if you need to drive sustained high volume. Treat the API as suitable for transactional workflows rather than bulk batch imports. ### How do I attribute an order to an affiliate through Jentic? Run pip install jentic, then search for 'create an affiliate order'. Jentic returns the POST /orders operation with its schema. Pass the partner ID and order details (amount, currency, external order ID), then execute. The commission calculation runs server-side based on the partner's group rules. ### Does the GrowthHero API support recurring subscription commissions? Yes. The Subscriptions resource in the API tracks subscription-linked commissions so that recurring orders continue paying the originating affiliate. Use the subscriptions endpoints to list and manage these recurring entries alongside the standard /orders flow. ### Can I delete a partner if they leave the program? Yes - DELETE /partners/{id} removes the partner record. Note that deleting a partner does not retroactively reverse commissions on past orders; if you need to claw back a balance, use POST /partners/{id}/adjust_balance with a negative delta before deleting. ### Can I limit what my agent is allowed to do with the GrowthHero API? Yes. Because you run Jentic One self-hosted, your own rules decide which GrowthHero operations the agent may call, so sensitive actions like POST /partners/{id}/generate_payout and POST /partners/{id}/adjust_balance are excluded unless you add them. Since GrowthHero puts the partner id in the URL path, you can also pin the agent to a single partner and let it only read GET /partners/{id}/transactions while keeping payouts and balance corrections off limits. The stored API key is injected at execution time and never reaches the agent's prompt or logs.