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

Verb routes: create, get, list

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

Reference for Verb, one group of Verb routes.

Verb.create

Creates a Verb. Verb page.

Text
POST /{namespace}/verbs

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

Inputs

InputTypeRequiredDescription
namestringrequiredThe camelCase action form.
eventstringrequiredThe event the Verb emits.
publishedInVersionThe first published Version that serves it; from then on, edits go through a Change and delete refuses.
nounNounEvery Verb acts on one Noun, which names it: Startup.launch acts on Startup.
modeModeThe Mode a call uses when the caller names none: try, send or do.

Returns

OutputTypeRequiredDescription
verbVerbrequiredThe Verb.

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/verbs \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline","event":"Example event"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "verb": {
    "$id": "https://api.sb/leaseline.app/verbs/verb_hlkWBvrAyZ",
    "$type": "Verb",
    "name": "Leaseline",
    "event": "Example event",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Verb.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Verb.get

Returns one Verb by id. Verb page.

Text
GET /{namespace}/verbs/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
verbVerbrequiredThe Verb.

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/verbs/verb_hlkWBvrAyZ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Verb",
  "$id": "https://api.sb/leaseline.app/verbs/verb_hlkWBvrAyZ",
  "verb": {
    "$id": "https://api.sb/leaseline.app/verbs/verb_hlkWBvrAyZ",
    "$type": "Verb",
    "name": "Leaseline",
    "event": "Example event",
    "status": "draft"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/verbs/verb_hlkWBvrAyZ",
    "up": "https://api.sb/leaseline.app/verbs"
  },
  "actions": {
    "retire": "https://api.sb/leaseline.app/verbs/verb_hlkWBvrAyZ/retire"
  }
}

Verb.list

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

Text
GET /{namespace}/verbs

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
verbslist of VerbrequiredOne page of Verbs.

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/verbs?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Verb",
  "verbs": [
    {
      "$id": "https://api.sb/leaseline.app/verbs/verb_hlkWBvrAyZ",
      "$type": "Verb",
      "name": "Leaseline",
      "event": "Example event",
      "status": "draft"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "verb_hlkWBvrAyZ"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/verbs?limit=20",
    "next": "https://api.sb/leaseline.app/verbs?after=verb_hlkWBvrAyZ"
  }
}

Verb

Previous

update, delete

Next