---
title: "This organisation's referral code and what it has earned"
description: "Retrieve the sign-up link code, the referrals it brought (status and date, never who), and earned credits: a bonus for the referred organisation when it signs up, then for you when it first uses Grid82 and first subscribes."
canonical: "https://grid82.com/docs/builder-api/referrals/get"
updated: "2026-11-13"
---

# This organisation's referral code and what it has earned

`GET https://studio.grid82.app/v1/organizations/{organizationId}/referrals`

Retrieve the sign-up link code, the referrals it brought (status and date, never who), and earned credits: a bonus for the referred organisation when it signs up, then for you when it first uses Grid82 and first subscribes.

While sign-ups are closed, the code cannot bring anybody in. Available to admins and builders on every suite.

Requires the `account:read` scope. Operation `referrals.get`. MCP tool `referrals_get`. CLI: `grid82 referrals get` (`npx grid82`).

## Path parameters

| Name             | Type   | Required | Description |
| ---------------- | ------ | -------- | ----------- |
| `organizationId` | string | yes      |             |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`object`, required)
- `data.code` (`string`, required)
- `data.link` (`string`, required)
- `data.signupsOpen` (`boolean`, required)
- `data.referrals` (`object[]`, required)
- `data.referrals.status` (`enum<string>`, required, one of: `pending, rewarded, void`)
- `data.referrals.createdAt` (`string`, required)
- `data.rewards` (`object`, required)
- `data.rewards.pendingCredits` (`number`, required)
- `data.rewards.earnedCredits` (`number`, required)
- `data.rewards.perReferral` (`object`, required)
- `data.rewards.perReferral.referred` (`number`, required)
- `data.rewards.perReferral.firstUse` (`number`, required)
- `data.rewards.perReferral.firstPurchase` (`number`, required)

```json
{
  "data": {
    "code": "<string>",
    "link": "<string>",
    "signupsOpen": true,
    "referrals": [
      {
        "status": "pending",
        "createdAt": "<string>"
      }
    ],
    "rewards": {
      "pendingCredits": 123.45,
      "earnedCredits": 123.45,
      "perReferral": {
        "referred": 123.45,
        "firstUse": 123.45,
        "firstPurchase": 123.45
      }
    }
  }
}
```

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

```json
{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}
```

**Example request**

```bash
curl --request GET \
  --url 'https://studio.grid82.app/v1/organizations/<organizationId>/referrals' \
  --header 'Authorization: Bearer <token>'
```