← Tools Reference

PartnerStack Partner

PartnerStack Partner integration (Marketing, Finance). Imported from open-connector.

API key5 toolshttps://api.partnerstack.com/api/v2
GET
partner_stack_partner_list_marketplace_programs
List active marketplace programs available through the PartnerStack Partner API.

/marketplace/programs/{min_created}

6 parameters
ParamTypeRequiredDescription
min_createdintegerrequiredOnly return programs created at or after this epoch millisecond timestamp.
max_createdintegeroptionalOnly return programs created at or before this epoch millisecond timestamp.
categorystringoptionalOnly return programs in this marketplace category.
limitintegeroptionalThe number of items to request. PartnerStack allows 1 to 250.
starting_afterstringoptionalA cursor item key used to return the following page of list results.
ending_beforestringoptionalA cursor item key used to return the previous page of list results.
GET
partner_stack_partner_get_marketplace_program
Retrieve one marketplace program by company key through the PartnerStack Partner API.

/marketplace/programs/{company_key}

1 parameter
ParamTypeRequiredDescription
company_keystringrequiredThe PartnerStack company key of the marketplace program.
GET
partner_stack_partner_list_partnerships
List partnerships managed by or owned by the connected PartnerStack partner account.

/partnerships/{order_by}

7 parameters
ParamTypeRequiredDescription
order_bystringrequiredThe partnership ordering expression.
has_sub_idstringoptionalWhether the program uses sub IDs.
include_offersbooleanoptionalWhether to include offers in each partnership response.
include_archivedbooleanoptionalWhether to include archived partnerships.
limitintegeroptionalThe number of items to request. PartnerStack allows 1 to 250.
starting_afterstringoptionalA cursor item key used to return the following page of list results.
ending_beforestringoptionalA cursor item key used to return the previous page of list results.
GET
partner_stack_partner_list_rewards
List rewards for the connected PartnerStack partner account.

/rewards/{company_key}

19 parameters
ParamTypeRequiredDescription
company_keystringrequiredOnly return rewards for this PartnerStack company key.
payment_statusstringoptionalThe reward payment status.
max_createdintegeroptionalOnly return rewards created at or before this epoch millisecond timestamp.
min_createdintegeroptionalOnly return rewards created at or after this epoch millisecond timestamp.
order_bystringoptionalThe reward ordering expression.
group_keystringoptionalOnly return rewards for this PartnerStack group key.
customer_keystringoptionalOnly return rewards for this PartnerStack customer key.
invoice_keystringoptionalOnly return rewards for this PartnerStack invoice key.
statusstringoptionalOnly return rewards with this reward status.
exclude_drip_rewardsstringoptionalWhether drip rewards should be excluded.
hide_archived_rewardsbooleanoptionalWhether archived rewards should be hidden.
empty_line_idbooleanoptionalWhether returned drip rewards must have an empty line ID.
keywordsstringoptionalFree-text keywords used by PartnerStack to filter rewards.
descriptionstringoptionalOnly return rewards whose description contains this text.
distinct_descriptionbooleanoptionalWhether reward descriptions should be distinct.
distinct_decline_reasonbooleanoptionalWhether reward decline reasons should be distinct.
limitintegeroptionalThe number of items to request. PartnerStack allows 1 to 250.
starting_afterstringoptionalA cursor item key used to return the following page of list results.
ending_beforestringoptionalA cursor item key used to return the previous page of list results.
GET
partner_stack_partner_list_payouts
List payouts for the connected PartnerStack partner account.

/payouts/{min_created}

6 parameters
ParamTypeRequiredDescription
min_createdintegerrequiredOnly return payouts created at or after this epoch millisecond timestamp.
max_createdintegeroptionalOnly return payouts created at or before this epoch millisecond timestamp.
order_bystringoptionalThe payout ordering expression.
limitintegeroptionalThe number of items to request. PartnerStack allows 1 to 250.
starting_afterstringoptionalA cursor item key used to return the following page of list results.
ending_beforestringoptionalA cursor item key used to return the previous page of list results.