Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APILegal & trustRisk

Risk routes: create, get, list

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

Reference for Risk, one group of Risk routes.

Risk.create

Creates a Risk. Verb page.

Text
POST /{namespace}/risks

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

Inputs

InputTypeRequiredDescription
scopestringrequiredWhose Risk it is: startup or portfolio, for exposure shared across siblings.
likelihoodintegerrequiredHow likely it is within a year, from 1 (rare) to 5 (expected).
impactintegerrequiredHow much harm it does if it happens, from 1 (minor) to 5 (ends the Startup).
treatmentstringThe chosen response: treat, accept, transfer, or avoid.
ownerRolerequiredThe Role that owns the Risk and its next review.
reviewBydateWhen the owner next scores it again.
portfolioPortfolioExposure shared across sibling Startups, such as one upstream every sibling relies on.

Returns

OutputTypeRequiredDescription
riskRiskrequiredThe Risk.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
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.

Text
GET /{namespace}/risks/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Risk.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
riskRiskrequiredThe Risk.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
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.

Text
GET /{namespace}/risks

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

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
riskslist of RiskrequiredOne page of Risks.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
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"
  }
}

Risk

Previous

update

Next