# Referral routes: create, get, list

URL: /code/api/referral/records · Id: `page:code/api/referral/records`

> The Referral Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for [Referral](/business/nouns/referral), one group of [Referral routes](/code/api/referral).

### Referral.create
Creates a Referral. [Verb page](/business/nouns/referral/create?interface=api).

```text
POST /{namespace}/referrals
```

Body, as JSON: the inputs. Emits `Referral.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `reward` | `money` | No | What the referrer earns. |
| `rewardKind` | `string` | No | What the referrer earns: earlier `access`, or `cash`, which pays only after Live. |
| `party` | [Party](/business/nouns/party) | No | The Party who sends a Referral earns its reward. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `referral` | [Referral](/business/nouns/referral) | Yes | The Referral. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/referrals \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reward":{"amount":29,"currency":"USD"}}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "referral": {
    "$id": "https://api.sb/leaseline.app/referrals/referral_I89J7wngKt",
    "$type": "Referral",
    "reward": {
      "amount": 29,
      "currency": "USD"
    },
    "rewardKind": "access"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Referral.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Referral.get
Returns one Referral by id. [Verb page](/business/nouns/referral/get?interface=api).

```text
GET /{namespace}/referrals/{id}
```

Path: `id`. Query: the other inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Referral. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `referral` | [Referral](/business/nouns/referral) | Yes | The Referral. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl https://api.sb/leaseline.app/referrals/referral_I89J7wngKt \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Referral",
  "$id": "https://api.sb/leaseline.app/referrals/referral_I89J7wngKt",
  "referral": {
    "$id": "https://api.sb/leaseline.app/referrals/referral_I89J7wngKt",
    "$type": "Referral",
    "reward": {
      "amount": 29,
      "currency": "USD"
    },
    "rewardKind": "access"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/referrals/referral_I89J7wngKt",
    "up": "https://api.sb/leaseline.app/referrals"
  }
}
```

### Referral.list
Returns Referrals, newest first, one page at a time. [Verb page](/business/nouns/referral/list?interface=api).

```text
GET /{namespace}/referrals
```

Query: the inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `referrals` | list of [Referral](/business/nouns/referral) | Yes | One page of Referrals. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl "https://api.sb/leaseline.app/referrals?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Referral",
  "referrals": [
    {
      "$id": "https://api.sb/leaseline.app/referrals/referral_I89J7wngKt",
      "$type": "Referral",
      "reward": {
        "amount": 29,
        "currency": "USD"
      },
      "rewardKind": "access"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "referral_I89J7wngKt"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/referrals?limit=20",
    "next": "https://api.sb/leaseline.app/referrals?after=referral_I89J7wngKt"
  }
}
```