# Risk routes: create, get, list

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

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

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

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

```text
POST /{namespace}/risks
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `scope` | `string` | Yes | Whose Risk it is: `startup` or `portfolio`, for exposure shared across siblings. |
| `likelihood` | `integer` | Yes | How likely it is within a year, from 1 (rare) to 5 (expected). |
| `impact` | `integer` | Yes | How much harm it does if it happens, from 1 (minor) to 5 (ends the Startup). |
| `treatment` | `string` | No | The chosen response: `treat`, `accept`, `transfer`, or `avoid`. |
| `owner` | [Role](/business/nouns/role) | Yes | The Role that owns the Risk and its next review. |
| `reviewBy` | `date` | No | When the owner next scores it again. |
| `portfolio` | [Portfolio](/business/nouns/portfolio) | No | Exposure shared across sibling Startups, such as one upstream every sibling relies on. |

**Returns**

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

**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/risks \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scope":"Example scope","likelihood":1,"impact":1,"owner":"role_oloMFMUeCH"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "risk": {
    "$id": "https://api.sb/leaseline.app/risks/risk_a3Rw0qcmRy",
    "$type": "Risk",
    "scope": "Example scope",
    "likelihood": 1,
    "impact": 1,
    "owner": "role_oloMFMUeCH"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Risk.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

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

```text
GET /{namespace}/risks/{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 Risk. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

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

**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/risks/risk_a3Rw0qcmRy \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Risk",
  "$id": "https://api.sb/leaseline.app/risks/risk_a3Rw0qcmRy",
  "risk": {
    "$id": "https://api.sb/leaseline.app/risks/risk_a3Rw0qcmRy",
    "$type": "Risk",
    "scope": "Example scope",
    "likelihood": 1,
    "impact": 1,
    "owner": "role_oloMFMUeCH"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/risks/risk_a3Rw0qcmRy",
    "up": "https://api.sb/leaseline.app/risks"
  },
  "actions": {
    "accept": "https://api.sb/leaseline.app/risks/risk_a3Rw0qcmRy/accept",
    "assess": "https://api.sb/leaseline.app/risks/risk_a3Rw0qcmRy/assess",
    "close": "https://api.sb/leaseline.app/risks/risk_a3Rw0qcmRy/close"
  }
}
```

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

```text
GET /{namespace}/risks
```

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 |
| --- | --- | --- | --- |
| `risks` | list of [Risk](/business/nouns/risk) | Yes | One page of Risks. |

**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/risks?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Risk",
  "risks": [
    {
      "$id": "https://api.sb/leaseline.app/risks/risk_a3Rw0qcmRy",
      "$type": "Risk",
      "scope": "Example scope",
      "likelihood": 1,
      "impact": 1,
      "owner": "role_oloMFMUeCH"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "risk_a3Rw0qcmRy"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/risks?limit=20",
    "next": "https://api.sb/leaseline.app/risks?after=risk_a3Rw0qcmRy"
  }
}
```