For the complete documentation index, see llms.txt. This page is also available as Markdown.

Directory Offer Object

Directory Offer Object

The partner-facing view of a joinable offer in the Offers Directory. Also inlined as offer on an Offer Recommendation Object.

Field
Type
Description

uuid

String

Offer UUID.

headline

String

Offer headline.

description

String | null

Offer description.

terms

String | null

Offer terms.

conversion_type

String

What counts as a conversion (e.g. lead).

category

String | null

Offer category.

image_url

String

Offer image URL.

commissions

Array

Payout tiers: type (fixed_amount/percentage), amount, description.

geo_restrictions

Object

Accepted-referral geography: allow_worldwide_referrals, allowed_countries, blocked_countries.

source

String

external-brand, internal, or sparkloop-network.

brand

Object

name, logo_url.

max_payout

Number

The offer's monthly budget, in dollars.

Example

{
  "uuid": "offer_1a2b3c",
  "headline": "Get 20% off Acme Pro",
  "description": "Premium productivity tools for newsletter teams.",
  "terms": "New customers only.",
  "conversion_type": "lead",
  "category": "Productivity",
  "image_url": "https://assets.sparkloop.app/offers/offer_1a2b3c.png",
  "commissions": [
    { "type": "fixed_amount", "amount": 2.0, "description": "Per verified lead" }
  ],
  "geo_restrictions": {
    "allow_worldwide_referrals": true,
    "allowed_countries": [],
    "blocked_countries": []
  },
  "source": "external-brand",
  "brand": {
    "name": "Acme Inc.",
    "logo_url": "https://assets.sparkloop.app/brands/acme.png"
  },
  "max_payout": 1000.0
}