Last updated

lookupAffiliate()

Looks up affiliate information by various attribution methods.

Signature

const affiliate = await window.FairShareSDK.lookupAffiliate(options);

Parameters

ParameterTypeDescription
optionsobjectLookup options

Lookup Options (use one):

PropertyTypeDescription
share_guidstringAffiliate's share GUID
emailstringAffiliate's email
usernamestringAffiliate's username
external_idstringExternal ID
fluid_rep_idnumberFluid Rep ID

Returns

Promise<Affiliate | null> — Affiliate object, or null if not found.

Examples

By Share GUID

const affiliate = await window.FairShareSDK.lookupAffiliate({
  share_guid: "abc123",
});

By Email

const affiliate = await window.FairShareSDK.lookupAffiliate({
  email: "affiliate@example.com",
});

By Username

const affiliate = await window.FairShareSDK.lookupAffiliate({
  username: "affiliateuser",
});

Affiliate Object

{
  id: 123,
  name: "John Doe",
  email: "john@example.com",
  image_url: "https://...",
  share_guid: "abc123"
}