GrowthHero.io
GrowthHero • growthhero
Help
Apiary Powered Documentation
Sign in with Apiary account.
Apiary Powered Documentation
Sign in with Apiary account.
The GrowthHero API is based around REST. It has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. JSON is returned by all API responses, including errors.
Your store falls under one of the following platform types.
There are platform specific attributes within the endpoints that cannot be modified if it is not supported for your store platform. The platform specific attributes will be explicitly marked under respective API endpoints. Please check and ensure you are not using unpermitted parameters for your platform.
The response object will still include the restricted attributes, you can safely ignore them.
If platform is not specified for any attribute, it is available for all the platforms.
Feel free to reach out if you need any API customizations.
Authentication with the API is achieved by sending your secret key along in the header of every request:
You can get your API key from Settings > Integrations > API page.
Premium APIs will be denoted as "Premium API" under each collection title. These endpoints can only be accessed by Premium accounts. You can upgrade your account anytime from Billing
Premium API
Partners represent users that will be promoting your company.
Returns a list of all your partners.
| page | a number used for pagination |
|---|---|
| search | a phrase used to filter the partner list |
Create a new affiliate account.
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify, bigcommerce)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify, bigcommerce)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify, bigcommerce)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify, bigcommerce)
Premium API
Partners represent users that will be promoting your company.
Update an existing affiliate account.
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify, bigcommerce)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify, bigcommerce)
Generate a payout for remaining balance of the partner.
Adjust the balance of a partner either positively or negatively
Get all transactions for a partner. Filter by Type.
| page | page number for result |
|---|---|
| per_page | number of resources to return in a single request. Maximum 250, default 25. |
| types | comma separated types to filter transactions from. Available - ManualTransacti |
Orders referred by your partners.
Returns a list of all your orders.
| page | a number used for pagination |
|---|---|
| search | a phrase used to filter the partner list |
Create a new affiliated order.
optional when auto_match_partner is true
when provided true, we will try to identify the match partner from any email events in last 24h from the pixel installation matching the customer email of the order.
platform: (shopify, bigcommerce)
platform: (shopify, bigcommerce)
platform: (shopify, bigcommerce)
when provided, the order type will be a "Subscription" else it will be categorized as "Individual Sale".
Single order referred by one of your partners.
Group (program) related APIs
Premium API
Retrieve paginated list of all groups. Returns 25 groups per call.
| page | |
|---|---|
| search | Filter groups by it's name or slug |
| show_all | Whether to skip pagination and return the full list of groups |
| type | Filter groups by it's type. |
Create a new Group.
Available: Shopify: [affiliate, referral] Standalone, BigCommerce: [affiliate]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
Available: Shopify: [cookie, first, lifetime] Standalone, BigCommerce: [first, lifetime]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
Premium API
A single Group object with all attributes.
| id | Numeric |
|---|
Update Group object
Available: Shopify: [affiliate, referral] Standalone, BigCommerce: [affiliate]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
Available: Shopify: [cookie, first, lifetime] Standalone, BigCommerce: [first, lifetime]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
Available: Shopify: [affiliate, referral] Standalone, BigCommerce: [affiliate]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
Available: Shopify: [cookie, first, lifetime] Standalone, BigCommerce: [first, lifetime]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
Available: Shopify: [affiliate, referral] Standalone, BigCommerce: [affiliate]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
Available: Shopify: [cookie, first, lifetime] Standalone, BigCommerce: [first, lifetime]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
Payout Batch related apis
Premium API
Retrieve paginated list of all payout batches. Returns 25 groups per call.
| page | |
|---|---|
| partner_id | Filter payout batches by partner |
Generate a mass payout. Payout will be generated for all eligible partners with eligible balance.
Premium API
A single PayoutBatch object with all attributes.
| id | Numeric |
|---|
Authorize a payout batch by supplying the paypal password.
| id | payout batch ID |
|---|
Create & manage customer Subscriptions.
Retrieve paginated list of all subscriptions. Returns 25 subscriptions per call.
| page | |
|---|---|
| search | Search subscriptions by partner name, customer name, plan name |
Create a new Subscription.
options: [active, inactive]
optional when auto_match_partner is true
when provided true, we will try to identify the match partner from any email events in last 24h from the pixel installation matching the customer email of the subscription.
A single Subscription object with all attributes.
| id | Numeric |
|---|
Update Subscription object
options: [active, inactive]
options: [active, inactive]
options: [active, inactive]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify, bigcommerce)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify, bigcommerce)
optional when auto_match_partner is true
when provided true, we will try to identify the match partner from any email events in last 24h from the pixel installation matching the customer email of the order.
platform: (shopify, bigcommerce)
platform: (shopify, bigcommerce)
platform: (shopify, bigcommerce)
when provided, the order type will be a "Subscription" else it will be categorized as "Individual Sale".
Available: Shopify: [affiliate, referral] Standalone, BigCommerce: [affiliate]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
Available: Shopify: [cookie, first, lifetime] Standalone, BigCommerce: [first, lifetime]
platform: (shopify)
platform: (shopify)
platform: (shopify)
platform: (shopify)
options: [active, inactive]
optional when auto_match_partner is true
when provided true, we will try to identify the match partner from any email events in last 24h from the pixel installation matching the customer email of the subscription.
options: [active, inactive]