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

Purpose routes: create, get, list

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

Reference for Purpose, one group of Purpose routes.

Purpose.create

Creates a Purpose. Verb page.

Text
POST /{namespace}/purposes

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

Inputs

InputTypeRequiredDescription
namestringrequiredThe reason, such as marketing email or call recording.

Returns

OutputTypeRequiredDescription
purposePurposerequiredThe Purpose.

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

Purpose.get

Returns one Purpose by id. Verb page.

Text
GET /{namespace}/purposes/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
purposePurposerequiredThe Purpose.

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/purposes/purpose_Aoz9nBatRR \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Purpose",
  "$id": "https://api.sb/leaseline.app/purposes/purpose_Aoz9nBatRR",
  "purpose": {
    "$id": "https://api.sb/leaseline.app/purposes/purpose_Aoz9nBatRR",
    "$type": "Purpose",
    "name": "Leaseline"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/purposes/purpose_Aoz9nBatRR",
    "up": "https://api.sb/leaseline.app/purposes"
  }
}

Purpose.list

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

Text
GET /{namespace}/purposes

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
purposeslist of PurposerequiredOne page of Purposes.

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

Purpose

Previous

update, delete

Next