Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthKey Result

Key Result routes: create, get, list

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

Reference for Key Result, one group of Key Result routes.

KeyResult.create

Creates a Key Result. Verb page.

Text
POST /{namespace}/key-results

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

Inputs

InputTypeRequiredDescription
baselinenumberrequiredWhere the Metric started.
targetnumberrequiredWhere the Metric must reach.
deadlinedaterequiredWhen it must reach it.
goalGoalA Goal is met when its Key Results reach their targets.
metricMetricA Key Result compares one Metric’s value against its baseline and target.

Returns

OutputTypeRequiredDescription
keyResultKey ResultrequiredThe Key Result.

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/key-results \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"baseline":1,"target":1,"deadline":"2026-10-22"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "keyResult": {
    "$id": "https://api.sb/leaseline.app/key-results/kr_fN3pcvG8sq",
    "$type": "KeyResult",
    "baseline": 1,
    "target": 1,
    "deadline": "2026-10-22"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "KeyResult.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

KeyResult.get

Returns one Key Result by id. Verb page.

Text
GET /{namespace}/key-results/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
keyResultKey ResultrequiredThe Key Result.

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/key-results/kr_fN3pcvG8sq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "KeyResult",
  "$id": "https://api.sb/leaseline.app/key-results/kr_fN3pcvG8sq",
  "keyResult": {
    "$id": "https://api.sb/leaseline.app/key-results/kr_fN3pcvG8sq",
    "$type": "KeyResult",
    "baseline": 1,
    "target": 1,
    "deadline": "2026-10-22"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/key-results/kr_fN3pcvG8sq",
    "up": "https://api.sb/leaseline.app/key-results"
  }
}

KeyResult.list

Returns Key Results, newest first, one page at a time. Verb page.

Text
GET /{namespace}/key-results

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
keyResultslist of Key ResultrequiredOne page of Key Results.

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/key-results?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "KeyResult",
  "keyResults": [
    {
      "$id": "https://api.sb/leaseline.app/key-results/kr_fN3pcvG8sq",
      "$type": "KeyResult",
      "baseline": 1,
      "target": 1,
      "deadline": "2026-10-22"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "kr_fN3pcvG8sq"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/key-results?limit=20",
    "next": "https://api.sb/leaseline.app/key-results?after=kr_fN3pcvG8sq"
  }
}

Key Result

Previous

update, delete

Next