Skip to main content
GET
/
v1
/
affiliation_protocol
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/affiliation_protocol \
  --header 'Authorization: Bearer <token>'
{
  "id": "652073a0-97ad-4127-bd27-ff873608471d",
  "object": "affiliation_protocol",
  "affiliation_request_bio_label": null,
  "affiliation_request_payout_email_enabled": false,
  "auto_approve_affiliations": false,
  "auto_approve_referrals": false,
  "description": null,
  "enabled": false,
  "external_portal_enabled": false,
  "external_portal_url": null,
  "payout_description": null,
  "portal_back_url": null,
  "portal_heading": "Affiliate Portal",
  "portal_description": "View your referrals, clicks, payout history, and manage your affiliate account.",
  "referral_url": null,
  "referrer_type": "last",
  "terms_url": null,
  "tracking_length_days": 30,
  "wordpress_plugin_tracking_enabled": true,
  "zero_commission_amount_referrals_enabled": true,
  "commission_structure": "05d07de5-1b18-4987-9a90-8f8a11c9e7ed",
  "created_at": 1767909660,
  "updated_at": 1767909660
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
affiliation_request_bio_label
string | null

The question affiliates are asked when they sign up.

​
affiliation_request_payout_email_enabled
boolean

Whether or not to include the payout email field on the affiliation request form.

​
auto_approve_affiliations
boolean

Whether or not to automatically approve affiliation requests.

​
auto_approve_referrals
boolean

Whether or not to automatically approve referrals.

​
description
string | null

A short description of how this store's affiliate program works. This will be displayed when affiliates request to join.

​
enabled
boolean

Whether or not this store is accepting new affiliation requests.

​
external_portal_enabled
boolean

Whether or not an external affiliate portal is being used. If true, affiliates will be redirected to the store's URL when they visit the hosted affiliate portal.

​
external_portal_url
string | null

If external_portal_enabled=true, where is the external portal hosted? If empty, the store's URL is used.

​
payout_description
string | null

A short description of how this store pays out commissions to affiliates.

​
portal_back_url
string | null

The back URL that is shown to affiliates on the affiliate portal.

​
portal_heading
string | null

The heading to display in the affiliate portal sidebar.

​
portal_description
string | null

The short description to display in the affiliate portal sidebar.

​
referral_url
string | null

The URL to use for affiliate referrals. This will be used to generate affiliate referral links.

​
referrer_type
string

The referrer strategy to use for referrals – one of first or last.

​
terms_url
string | null

The URL to the terms and conditions for this store's affiliate program.

​
tracking_length_days
integer

The number of days to track affiliate clicks for. This determines how long the click tracking cookie will last for.

​
wordpress_plugin_tracking_enabled
boolean

Whether or not the WordPress plugin should automatically add the tracking script.

​
zero_commission_amount_referrals_enabled
boolean

Whether or not to create a referral from a checkout when the resulting referral has a commission_amount of 0.

​
commission_structure

Expandable – The associated commission structure ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.