---
title: "Referral codes and their claims"
method: GET
path: "/preview/referrals"
tags: ["referrals"]
---

# Referral codes and their claims

`GET /preview/referrals`

## Request

- Base URL: `https://autoresearch.sfcompute.com`
- URL: `https://autoresearch.sfcompute.com/preview/referrals`
- Auth: HTTP bearer

The organization's referral codes and earnings (any member): each code with its share link, the credit balance, and the most recent earnings (kind, who it came from, amount, minted, expiry). Every dollar a referred org spends (cash-settled) earns you credits at the program rate; credits expire 3 weeks after minting, oldest consumed first. The full history and charts live on /referrals.

## Query parameters

- `cursor` string: Opaque page cursor: the `next_cursor` a previous response returned. Omit for the first page.
- `limit` integer: Rows per page. Clamped to the range shown.
- `workspace` string

## Request body

- object
  - `org` string, nullable: Organization (uuid or name); omitted = your active org.

## Response `200`

The capability's JSON result.

- List: The list envelope every paging endpoint returns.
  - `items` Result[], required
    - `object` string: The resource type, when the result is one resource.
  - `next_cursor` string: Pass as ?cursor= for the next page. Absent on the last page. Opaque: never parse it.
  - `object` 'list', required

## Other responses

- `400`: Malformed request: bad JSON, a parameter that does not parse, or a value outside its range. Code `invalid`.
- `401`: No bearer token, or one this API cannot verify. Code `unauthenticated`.
- `403`: Authenticated, but the token's scopes or the account's role do not reach this operation. The message names the scope word to request. Code `forbidden`.
- `404`: No such route. Code `not_found`; the body names the OpenAPI document.
- `422`: A well-formed request the platform declined: no such node, a cap reached, a state that forbids the move. The message says which, and what to do instead. Code `refused`.
- `429`: Over this door's per-customer budget. Wait `Retry-After` seconds. Code `rate_limited`.
- `500`: Our fault. Retry; if it persists, quote the request-id. Code `internal`.

---

[API](https://skmtc.dev/givemeanode/apis/autoresearch-customer-api.md) · [All operations](https://skmtc.dev/givemeanode/apis/autoresearch-customer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/givemeanode/apis/autoresearch-customer-api/revisions/f88dcb70ac6c?raw)