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

Goal routes: create, get, list

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

Reference for Goal, one group of Goal routes.

Goal.create

Creates a Goal. Verb page.

Text
POST /{namespace}/goals

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

Inputs

InputTypeRequiredDescription
objectivetextrequiredThe qualitative outcome.
horizonstringOne of day, week, quarter, year, or three-years.
thingThingEvery Thing pursues Goals, such as a Startup’s quarterly objective or a Team’s weekly target.

Returns

OutputTypeRequiredDescription
goalGoalrequiredThe Goal.

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/goals \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"objective":"Example objective"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "goal": {
    "$id": "https://api.sb/leaseline.app/goals/goal_L9PBQQhfuF",
    "$type": "Goal",
    "objective": "Example objective"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Goal.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Goal.get

Returns one Goal by id. Verb page.

Text
GET /{namespace}/goals/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
goalGoalrequiredThe Goal.

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/goals/goal_L9PBQQhfuF \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Goal",
  "$id": "https://api.sb/leaseline.app/goals/goal_L9PBQQhfuF",
  "goal": {
    "$id": "https://api.sb/leaseline.app/goals/goal_L9PBQQhfuF",
    "$type": "Goal",
    "objective": "Example objective"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/goals/goal_L9PBQQhfuF",
    "up": "https://api.sb/leaseline.app/goals"
  }
}

Goal.list

Returns Goals, newest first, one page at a time. Verb page.

Text
GET /{namespace}/goals

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
goalslist of GoalrequiredOne page of Goals.

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/goals?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Goal",
  "goals": [
    {
      "$id": "https://api.sb/leaseline.app/goals/goal_L9PBQQhfuF",
      "$type": "Goal",
      "objective": "Example objective"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "goal_L9PBQQhfuF"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/goals?limit=20",
    "next": "https://api.sb/leaseline.app/goals?after=goal_L9PBQQhfuF"
  }
}

Goal

Previous

update, delete

Next