---
title: "Partner referral code and attributed organizations"
method: GET
path: "/referrals"
tags: ["Organizations"]
---

# Partner referral code and attributed organizations

`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`

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.

## Response `200`

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

- object
  - `referral_code` string, nullable, required: 8 characters from ABCDEFGHJKMNPQRSTUVWXYZ23456789, or null when none has been minted.
  - `share_url` string, nullable, required: Null exactly when referral_code is null.
  - `referred` object[], required
    - `organization_public_id` string: Omitted when the referred organization has no public id.
    - `display_name` string, required
    - `referred_at` string, date-time, required
    - `verification_status` string, required
  - `total` integer, required

## Other responses

- `401`: Authentication required
- `403`: API key lacks the read:orgs scope
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/arkova/apis/arkova-verification-api.md) · [All operations](https://skmtc.dev/arkova/apis/arkova-verification-api/llms.txt) · [OpenAPI document](https://skmtc.dev/arkova/apis/arkova-verification-api/revisions/a14858d1efd4?raw)