---
title: "Your referral link, the companies that signed up with it, and the credit earned."
method: GET
path: "/v1/referrals"
tags: ["referrals"]
---

# Your referral link, the companies that signed up with it, and the credit earned.

`GET /v1/referrals`

## Request

- Base URL: `https://api.withruntime.com`
- URL: `https://api.withruntime.com/v1/referrals`
- Auth: HTTP bearer

A company that signs up with your link has every payment in its first 30 days matched, up to $1,000 in total, and you get the same, payment by payment; its first payment of at least $10 gives each side at least $25. Then, for 12 months, you earn 10% of what it spends from credit it paid for, credited monthly. You earn at most $50,000 a calendar year, matches and share together. Money is integer microdollars in strings.

## Response `200`

Success

- object
  - `code` string, required: Your organization's referral code. Permanent.
  - `link` string, required: Share this: https://withruntime.com/r/<code>.
  - `rewardMicros` string, required: The least each side gets on the referred company's first qualifying payment: a smaller one is matched up to this. Integer microdollars, as a string.
  - `maxRewardMicros` string, required: The most each side gets per referred company, all its matched payments together. Integer microdollars, as a string.
  - `minPurchaseMicros` string, required: The smallest payment a referral matches. Integer microdollars, as a string.
  - `yearlyCapMicros` string, required: The most referral credit, matches and share together, you can earn in one calendar year (UTC). Integer microdollars, as a string.
  - `enabled` boolean, required: False while the program is paused.
  - `year` integer, required
  - `signedUp` integer, required: Companies that signed up with your link.
  - `pending` integer, required: Signed up, first qualifying payment not made yet.
  - `paid` integer, required: Referrals with a payment matched: both sides credited.
  - `capped` integer, required: Paid, but the yearly cap left you less than a whole match.
  - `reversed` integer, required: Every matched payment was refunded or disputed below the minimum, so the matches were taken back.
  - `earnedMicros` string, required: Referral credit you kept, all time: matches and share. Integer microdollars, as a string.
  - `earnedThisYearMicros` string, required: Referral credit counted against this year's cap. Integer microdollars, as a string.
  - `capRemainingMicros` string, required: What you can still earn this year. Integer microdollars, as a string.
  - `payingCompanies` integer, required: Referred companies with a matched payment still standing.
  - `shareEarnedMicros` string, required: Share credit you kept, all time: credited, less what lost disputes took back. Integer microdollars, as a string.
  - `shareBasisPoints` integer, required: Your share of what a referred company spends from credit it paid for, in basis points: 1000 is 10%.
  - `shareMonths` integer, required: How long the share runs from a company's first matched payment.
  - `windowDays` integer, required: How long after sign-up a referred company's payments are matched.
  - `referredBy` object, nullable, required: Whether your organization signed up through someone's link, and the credit it got. Null when it did not.
    - `status` 'pending' | 'paid' | 'refused' | 'reversed'
    - `creditMicros` string: The referral credit your organization received. Integer microdollars, as a string.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/withruntime/apis/runtime-cloud-api.md) · [All operations](https://skmtc.dev/withruntime/apis/runtime-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/withruntime/apis/runtime-cloud-api/revisions/6f4012286988?raw)