Partner Programs

Get partner programs

GET https://api.sparkloop.app/v2/partner_network/partner_programs

Query Parameters

Name	Type	Description
cpa	integer	Limit search to partner programs with a CPA higher than a certain value
max_payout	integer	Limit search to partner programs with a Max Payout higher than a certain value
accepted_countries	string	Limit search to partner programs accepting referrals from specific countries. Comma separated list of ISO3166 country codes Example: US, CA
can_be_recommended_via	string	Limit search to partner programs that can be recommended via specific channels. Comma separated list of channels. Example: upscribe, partner_link or magic_link
sort	string	The criteria to sort partner programs by. Possible values: max_payout - Max payout (high to low) cpa - CPA (high to low) max_payout - Max payout (high to low)

200 Returns partner programs

{
  "partner_programs": [
    <Partner Program Object>,
    <Partner Program Object>,
    <Partner Program Object>,
  ],
  "meta": {
    "per_page": 2,
    "page": 1,
    "total_pages": 12,
    "total_partner_programs": 24
  }
}

Get a partner program

GET https://api.sparkloop.app/v2/partner_network/partner_programs/:identifier

Returns a single partner program by UUID

Path Parameters

Name	Type	Description
identifier*	string	Partner program's UUID

200 Returns partner program

{
  "partner_program": <Partner Program Object>
}

Join partner program

POST https://api.sparkloop.app/v2/partner_network/partner_programs/:identifier/join

Use this endpoint to join a partner program.

Path Parameters

Name	Type	Description
identifier*	string	Partner program's UUID

Request Body

Name	Type	Description
reason_for_recommending*	string	If the partner program requires partners to apply, the reason for recommending must be passed over

200 Returns partner program

{
    "partner_campaign": <Recommendation Object>
}

400

Unsupported status

{
    "error": "Some error"
}

Empty PUT body

{
    "error": "You have to update at least 1 field."
}