Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APILegal & trustReserved Act

Reserved Act routes: create, get, list

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

Reference for Reserved Act, one group of Reserved Act routes.

ReservedAct.create

Creates a Reserved Act. Verb page.

Text
POST /{namespace}/reserved-acts

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

Inputs

InputTypeRequiredDescription
jurisdictionstringrequiredWhere the law reserves it.
verbVerbThe Verb the law reserves to a credentialed Human in the act’s jurisdiction.

Returns

OutputTypeRequiredDescription
reservedActReserved ActrequiredThe Reserved Act.

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/tutorloop.com/reserved-acts \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jurisdiction":"US-DE"}'
JSON
{
  "api": "https://api.sb/tutorloop.com",
  "reservedAct": {
    "$id": "https://api.sb/tutorloop.com/reserved-acts/reserved_PKPVsB1HFf",
    "$type": "ReservedAct",
    "jurisdiction": "US-DE"
  },
  "action": {
    "$id": "https://api.sb/tutorloop.com/actions/act_DEVhiF6mF5",
    "operation": "ReservedAct.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/tutorloop.com/actions/act_DEVhiF6mF5"
  }
}

ReservedAct.get

Returns one Reserved Act by id. Verb page.

Text
GET /{namespace}/reserved-acts/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
reservedActReserved ActrequiredThe Reserved Act.

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/tutorloop.com/reserved-acts/reserved_PKPVsB1HFf \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/tutorloop.com",
  "$type": "ReservedAct",
  "$id": "https://api.sb/tutorloop.com/reserved-acts/reserved_PKPVsB1HFf",
  "reservedAct": {
    "$id": "https://api.sb/tutorloop.com/reserved-acts/reserved_PKPVsB1HFf",
    "$type": "ReservedAct",
    "jurisdiction": "US-DE"
  },
  "links": {
    "self": "https://api.sb/tutorloop.com/reserved-acts/reserved_PKPVsB1HFf",
    "up": "https://api.sb/tutorloop.com/reserved-acts"
  }
}

ReservedAct.list

Returns Reserved Acts, newest first, one page at a time. Verb page.

Text
GET /{namespace}/reserved-acts

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
reservedActslist of Reserved ActrequiredOne page of Reserved Acts.

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/tutorloop.com/reserved-acts?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/tutorloop.com",
  "$type": "ReservedAct",
  "reservedActs": [
    {
      "$id": "https://api.sb/tutorloop.com/reserved-acts/reserved_PKPVsB1HFf",
      "$type": "ReservedAct",
      "jurisdiction": "US-DE"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "reserved_PKPVsB1HFf"
  },
  "links": {
    "self": "https://api.sb/tutorloop.com/reserved-acts?limit=20",
    "next": "https://api.sb/tutorloop.com/reserved-acts?after=reserved_PKPVsB1HFf"
  }
}

Reserved Act

Previous

update, delete

Next