Organizations

Partner referral code and attributed organizations

Returns the calling organization's active referral code, the link to share, and the organizations that code introduced. The organization is derived from the API key — there is no organization parameter. Identifiers are public ids only. organization_public_id is omitted for an organization that has no public id. MEASURED: which organizations presented this code at creation, and when. NOT ASSERTED: any commission, payout, discount or revenue share. No field here feeds billing.

get/referrals

Request

  • Base URL: https://app.arkova.ai/api/v1
  • URL: https://app.arkova.ai/api/v1/referrals
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

Referral code and attributed organizations. An organization with no minted code returns referral_code: null and an empty list, not a 404.

referral_codestring nullable required

8 characters from ABCDEFGHJKMNPQRSTUVWXYZ23456789, or null when none has been minted.

share_urlstring nullable required

Null exactly when referral_code is null.

totalinteger required

Changes

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