Referral program

GET 
/affiliate

The account's enrolment in the referral program — the status, the public code, the terms in force and the count of referrals by status. For an account that has not enrolled, enrolled: false and the terms on offer in offer.

The payout details come masked: the full destination never leaves the API.

Responses

200

Record found.

401

Missing, malformed, unknown or revoked token (authentication), or a suspended account (tenant_inactive).

429

Rate limit exceeded (rate_limit).

Response Headers

Retry-After

Seconds to wait before retrying.

X-RateLimit-Category

Which rate limit category applied — send, media or default.

X-RateLimit-Scope

Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).

X-RateLimit-Limit

Request ceiling for this category in the current window.

X-RateLimit-Remaining

Requests left in the current window.