Get Marketplace Program

curl -X GET "https://api.affonso.io/v1/marketplace/prg_abc123"

{
  "success": true,
  "data": {
    "id": "prog_a1b2c3d4",
    "name": "Acme SaaS",
    "description": "The best project management tool for teams",
    "tagline": "Manage projects effortlessly",
    "category": "SaaS",
    "default_promotion_url": "https://acme.com",
    "logo_url": "https://cdn.affonso.io/logos/acme.png",
    "access_mode": "public",
    "currency": "USD",
    "commission": {
      "type": "COMMISSION",
      "value": 30,
      "is_percentage": true,
      "apply_to": "ALL_PLANS",
      "has_multiple_tiers": false
    },
    "terms": {
      "cookie_lifetime_days": 60,
      "payment_frequency": "monthly",
      "payment_threshold": 50,
      "payment_methods": ["paypal", "wise"],
      "additional_payment_terms": "Payouts are processed within 10 business days."
    },
    "benefits": {
      "coupon_codes": true,
      "affiliate_links": true,
      "manual_lead_submission": false,
      "creative_assets": true,
      "affiliate_manager": true,
      "attribution_model": "last_touch",
      "auto_approval": true,
      "sub_affiliates": false,
      "postback_tracking": true
    },
    "restrictions": {
      "websites": true,
      "social_marketing": true,
      "organic_social": true,
      "email_marketing": true,
      "mobile_traffic": true,
      "search_engine_marketing": false,
      "organic_search": true,
      "rebrokering": false,
      "incent": false,
      "brand_bidding": false,
      "additional_restrictions": "No adult content or gambling sites"
    }
  }
}

GET

marketplace

{id}

curl -X GET "https://api.affonso.io/v1/marketplace/prg_abc123"

{
  "success": true,
  "data": {
    "id": "prog_a1b2c3d4",
    "name": "Acme SaaS",
    "description": "The best project management tool for teams",
    "tagline": "Manage projects effortlessly",
    "category": "SaaS",
    "default_promotion_url": "https://acme.com",
    "logo_url": "https://cdn.affonso.io/logos/acme.png",
    "access_mode": "public",
    "currency": "USD",
    "commission": {
      "type": "COMMISSION",
      "value": 30,
      "is_percentage": true,
      "apply_to": "ALL_PLANS",
      "has_multiple_tiers": false
    },
    "terms": {
      "cookie_lifetime_days": 60,
      "payment_frequency": "monthly",
      "payment_threshold": 50,
      "payment_methods": ["paypal", "wise"],
      "additional_payment_terms": "Payouts are processed within 10 business days."
    },
    "benefits": {
      "coupon_codes": true,
      "affiliate_links": true,
      "manual_lead_submission": false,
      "creative_assets": true,
      "affiliate_manager": true,
      "attribution_model": "last_touch",
      "auto_approval": true,
      "sub_affiliates": false,
      "postback_tracking": true
    },
    "restrictions": {
      "websites": true,
      "social_marketing": true,
      "organic_social": true,
      "email_marketing": true,
      "mobile_traffic": true,
      "search_engine_marketing": false,
      "organic_search": true,
      "rebrokering": false,
      "incent": false,
      "brand_bidding": false,
      "additional_restrictions": "No adult content or gambling sites"
    }
  }
}

Retrieve a single program that is listed in the marketplace by ID. Only programs that have been published to the Affonso marketplace are available through this endpoint. This endpoint is public and does not require authentication.

Path Parameters

string

required

The unique identifier of the program to retrieve.

Response

boolean

Always true for successful responses

object

The marketplace program object.

Show Data Object Properties

string

Unique encoded identifier for the program

string

Program name

string | null

Program description

string | null

Short tagline for the program

string | null

Program category

string | null

Canonical global default promotion URL from the program’s promotion URL configuration

string | null

URL to the program’s logo image

string

Program access mode: public, private, or invite

string

Three-letter currency code (e.g. USD, EUR)

object | null

Commission details for the program’s default tier.

Show Commission Properties

string

Commission type (e.g. COMMISSION)

number

Commission amount

boolean

Whether the value is a percentage (true) or a fixed amount (false)

string

What the commission applies to

boolean

Whether the program has multiple commission tiers

object | null

Program terms and conditions.

Show Terms Properties

Number of days the referral cookie is valid

string

How often affiliates are paid: weekly, monthly, or quarterly

number

Minimum earnings before a payout is issued

array

Payment methods available to affiliates

string | null

Additional payment terms supplied by the program manager

object

Features available to affiliates in this program.

Show Benefits Properties

boolean

Whether an active self-service coupon blueprint is configured

boolean

Whether affiliate links are enabled

boolean

Whether affiliates can submit leads manually

boolean

Whether at least one creative asset is available

boolean

Whether an affiliate support email is configured

string

Attribution model used by the program. Currently always last_touch

boolean

Whether anyone can join and be approved automatically. This is true only for public programs; invite-only programs return false

boolean

Whether multi-level incentives are configured for at least one affiliate group

boolean

Whether postback tracking is enabled

object | null

Permitted affiliate promotion channels and additional restrictions, or null if not configured.

Show Restrictions Properties

boolean

Whether website traffic is allowed

Whether paid social marketing is allowed

Whether organic social traffic is allowed

boolean

Whether email marketing is allowed

boolean

Whether mobile traffic is allowed

boolean

Whether paid search traffic is allowed

boolean

Whether organic search traffic is allowed

boolean

Whether rebrokering is allowed

boolean

Whether incentivized traffic is allowed

boolean

Whether brand bidding is allowed

string | null

Free-text additional restrictions

curl -X GET "https://api.affonso.io/v1/marketplace/prg_abc123"

{
  "success": true,
  "data": {
    "id": "prog_a1b2c3d4",
    "name": "Acme SaaS",
    "description": "The best project management tool for teams",
    "tagline": "Manage projects effortlessly",
    "category": "SaaS",
    "default_promotion_url": "https://acme.com",
    "logo_url": "https://cdn.affonso.io/logos/acme.png",
    "access_mode": "public",
    "currency": "USD",
    "commission": {
      "type": "COMMISSION",
      "value": 30,
      "is_percentage": true,
      "apply_to": "ALL_PLANS",
      "has_multiple_tiers": false
    },
    "terms": {
      "cookie_lifetime_days": 60,
      "payment_frequency": "monthly",
      "payment_threshold": 50,
      "payment_methods": ["paypal", "wise"],
      "additional_payment_terms": "Payouts are processed within 10 business days."
    },
    "benefits": {
      "coupon_codes": true,
      "affiliate_links": true,
      "manual_lead_submission": false,
      "creative_assets": true,
      "affiliate_manager": true,
      "attribution_model": "last_touch",
      "auto_approval": true,
      "sub_affiliates": false,
      "postback_tracking": true
    },
    "restrictions": {
      "websites": true,
      "social_marketing": true,
      "organic_social": true,
      "email_marketing": true,
      "mobile_traffic": true,
      "search_engine_marketing": false,
      "organic_search": true,
      "rebrokering": false,
      "incent": false,
      "brand_bidding": false,
      "additional_restrictions": "No adult content or gambling sites"
    }
  }
}

Getting Started

Guide

Core Resources

Program Management

Marketplace

Get Marketplace Program

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response