Referral

Partner referral programme.

Partner referral programme. **Track referral link click (PUBLIC)** Track referral link click is a PUBLIC (no-auth) attribution endpoint that records a click on a referral code. **Get partner referral info + referred list** Get partner referral info is a partner-token endpoint returning the partner's own referral code + paginated list of companies referred through it (or, with call_for, the URL-widget payload).

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

Track referral link click (PUBLIC)

POST — Public attribution endpoint: records a click on a referral link identified by its referral code and increments that code's total_click counter.

Open →

Get partner referral info + referred list

GET — Get the authenticated partner's referral-programme details.

Open →


Did this page help you?