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

Problem routes: create, get, list

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

Reference for Problem, one group of Problem routes.

Problem.create

Creates a Problem. Verb page.

Text
POST /{namespace}/problems

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

Inputs

InputTypeRequiredDescription
statementtextrequiredThe struggle, in the words of the ICP.
costPerPeriodjsonWhat the Problem costs the ICP per period: hours times wage, or the spend on what they hire today.
addressjsonThe opportunity map cell it sits on: an occupation, a task it performs, and an industry.
momenttextThe moment the job starts, with the observable trigger that marks it.
progresstextThe progress the ICP wants, from the state before to the state after.
hiredTodayjsonWhat the ICP hires for the job today, by kind and cost: software, a Service, their own hands, or nothing.

Returns

OutputTypeRequiredDescription
problemProblemrequiredThe Problem.

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/problems \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"statement":"Tracks lease renewals for small property managers."}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "problem": {
    "$id": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
    "$type": "Problem",
    "statement": "Tracks lease renewals for small property managers."
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Problem.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Problem.get

Returns one Problem by id. Verb page.

Text
GET /{namespace}/problems/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
problemProblemrequiredThe Problem.

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/problems/problem_UzvXXfKsJB \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Problem",
  "$id": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
  "problem": {
    "$id": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
    "$type": "Problem",
    "statement": "Tracks lease renewals for small property managers."
  },
  "links": {
    "self": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
    "up": "https://api.sb/leaseline.app/problems"
  },
  "actions": {
    "notify": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB/notify",
    "vote": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB/vote"
  }
}

Problem.list

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

Text
GET /{namespace}/problems

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
problemslist of ProblemrequiredOne page of Problems.

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/problems?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Problem",
  "problems": [
    {
      "$id": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
      "$type": "Problem",
      "statement": "Tracks lease renewals for small property managers."
    }
  ],
  "meta": {
    "limit": 20,
    "after": "problem_UzvXXfKsJB"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/problems?limit=20",
    "next": "https://api.sb/leaseline.app/problems?after=problem_UzvXXfKsJB"
  }
}

Problem

Previous

update, delete

Next