Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APISpec and limitsAPI reference

Portfolio routes: create, get, list

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

Reference for Portfolio, one group of Portfolio routes.

Portfolio.create

Creates a Portfolio. Verb page.

Text
POST /{namespace}/portfolios

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

Inputs

InputTypeRequiredDescription
idstringThe stable identifier, which never changes.
typelist of NounThe Nouns this Thing is an instance of.
outsidejsonThe ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
queryjsonThe saved query that defines a dynamic Collection.
membershipstringHow each member belongs: held, owned, contracted, or made.
studioStudioA Studio allocates attention and money across the members of each Portfolio it manages.

Returns

OutputTypeRequiredDescription
portfolioPortfoliorequiredThe Portfolio.

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/portfolios \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"portfolio_zkvUnP8LwY"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "portfolio": {
    "$id": "https://api.sb/leaseline.app/portfolios/portfolio_zkvUnP8LwY",
    "$type": "Portfolio",
    "id": "Example id",
    "type": [
      "noun_v0akLUrXCN"
    ]
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Portfolio.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Portfolio.get

Returns one Portfolio by id. Verb page.

Text
GET /{namespace}/portfolios/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
portfolioPortfoliorequiredThe Portfolio.

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/portfolios/portfolio_zkvUnP8LwY \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Portfolio",
  "$id": "https://api.sb/leaseline.app/portfolios/portfolio_zkvUnP8LwY",
  "portfolio": {
    "$id": "https://api.sb/leaseline.app/portfolios/portfolio_zkvUnP8LwY",
    "$type": "Portfolio",
    "id": "Example id",
    "type": [
      "noun_v0akLUrXCN"
    ]
  },
  "links": {
    "self": "https://api.sb/leaseline.app/portfolios/portfolio_zkvUnP8LwY",
    "up": "https://api.sb/leaseline.app/portfolios"
  },
  "actions": {
    "brake": "https://api.sb/leaseline.app/portfolios/portfolio_zkvUnP8LwY/brake",
    "lift": "https://api.sb/leaseline.app/portfolios/portfolio_zkvUnP8LwY/lift"
  }
}

Portfolio.list

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

Text
GET /{namespace}/portfolios

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
portfolioslist of PortfoliorequiredOne page of Portfolios.

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