Get best referral code for a vendor

Returns the referral code AgentDeals holds for a vendor, or 404 when we hold none. Same shape is inlined on /api/offers, /api/compare, /api/details/{vendor}, /api/newest, and MCP tool responses.

get/api/referral-codes/{vendor}

Request

  • Base URL: https://agentdeals.dev
  • URL: https://agentdeals.dev/api/referral-codes/{vendor}
  • Auth: none required

Path parameters

vendorstring required

Vendor name (case-insensitive)

Response

Best available referral code

vendorstring required

Vendor/service name

categorystring nullable

Primary category for the vendor (null if unknown)

codestring required

The referral code string

referral_urlstring uri required

Full referral URL the referee should visit

referee_benefitstring required

What the person using the code gets (e.g. '$20 in credits')

restrictionsstring[] required

Conditions the referee must meet before the benefit is theirs (e.g. 'A payment method must be linked'). Empty when the record records none. Publish these wherever you publish referee_benefit.

source'platform' required

Always platform: a code AgentDeals holds and earns on. Agent-submitted codes are retired and none is served.

Changes

No recorded changes to this operation across all 1 revision of this API.