GrowthHero API
68
AI ReadinessAI-Aware (B+)68/100
Community OpenAPI document · agent-readyMarketingMarketing AutomationapiKey27 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Manage affiliate and referral programs - register partners, attribute orders, run payout batches, and adjust partner balances - through a single REST interface.
Use for: Register a new affiliate partner, List all partners in the program, Retrieve commission transactions for a partner, Generate a payout for a top-performing affiliate
Not supported: Does not handle payment processing, email marketing, or product catalogue management - use for affiliate and refer-a-friend program operations only.
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.
Install Jentic One Beta
Connect the GrowthHero API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the GrowthHero API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fapi.growthhero.io%2Fgrowthhero" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fapi.growthhero.io%2Fgrowthhero" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with GrowthHero API.
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
Patterns agents use GrowthHero API for, with concrete tasks.
★ 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.
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.
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.
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.
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
27 endpoints — the growthhero api is a restful interface for managing affiliate and refer-a-friend programs.
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
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
G
GrowthHero API
- AI-Aware (B+)68/100
93
Foundational Compliance63
Developer Experience & Jentic Compatibility51
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
93
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
3%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
51
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C-Signals: 4
38%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
66%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using GrowthHero API through Jentic.
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.
GET STARTED