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

Holder routes

Every Holder Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Holder.

NounSystemRun by
HolderEquityFounder

Holder.create

Creates a Holder. Verb page.

Text
POST /{namespace}/holders

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

Inputs

InputTypeRequiredDescription
partyPartyrequiredThe person or entity behind the holding.

Returns

OutputTypeRequiredDescription
holderHolderrequiredThe Holder.

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/holders \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"party":"party_hmQWaPrAyZ"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "holder": {
    "$id": "https://api.sb/leaseline.app/holders/holder_e2Dm5Y6QGO",
    "$type": "Holder",
    "party": "party_hmQWaPrAyZ"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Holder.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Holder.get

Returns one Holder by id. Verb page.

Text
GET /{namespace}/holders/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
holderHolderrequiredThe Holder.

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/holders/holder_e2Dm5Y6QGO \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Holder",
  "$id": "https://api.sb/leaseline.app/holders/holder_e2Dm5Y6QGO",
  "holder": {
    "$id": "https://api.sb/leaseline.app/holders/holder_e2Dm5Y6QGO",
    "$type": "Holder",
    "party": "party_hmQWaPrAyZ"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/holders/holder_e2Dm5Y6QGO",
    "up": "https://api.sb/leaseline.app/holders"
  }
}

Holder.list

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

Text
GET /{namespace}/holders

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
holderslist of HolderrequiredOne page of Holders.

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

Holder.update

Changes the given properties of a Holder. Verb page.

Text
PATCH /{namespace}/holders/{id}

Path: id. Body, as JSON: the other inputs. Emits Holder.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Holder.
partyPartyThe person or entity behind the holding.

Returns

OutputTypeRequiredDescription
holderHolderrequiredThe Holder.

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 PATCH https://api.sb/leaseline.app/holders/holder_e2Dm5Y6QGO \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"party":"party_hmQWaPrAyZ"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "holder": {
    "$id": "https://api.sb/leaseline.app/holders/holder_e2Dm5Y6QGO",
    "$type": "Holder",
    "party": "party_hmQWaPrAyZ"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Holder.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Forecast

Previous

Instrument

Next