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

Startup routes: create, get, list

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

Reference for Startup, one group of Startup routes.

Startup.create

Creates a Startup. Verb page.

Text
POST /{namespace}/startups

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

Inputs

InputTypeRequiredDescription
namestringrequiredThe name the Startup trades under.
domainurlThe canonical hostname of the Startup.
launchedAtdatetimeWhen the Startup went live.
templatestringThe slug of the template it extends; the root one when none is named.
ideatextThe Idea it starts from, in a sentence, recorded as its Idea.
spendStatestringHow freely money Limits allow spend: free, tight (discretionary Limits halved) or hold (one-way spend stops).
studioStudioA Studio founds and builds its Startups and runs Plays across them.
companyCompanyThe holding Company is the Startup’s owner of record: it signs its Agreements and owns its profit rights.

Returns

OutputTypeRequiredDescription
startupStartuprequiredThe Startup.

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

Startup.get

Returns one Startup by id. Verb page.

Text
GET /{namespace}/startups/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
startupStartuprequiredThe Startup.

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/startups/startup_l3hr1EnUGY \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Startup",
  "$id": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY",
  "startup": {
    "$id": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY",
    "$type": "Startup",
    "name": "Leaseline"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY",
    "up": "https://api.sb/leaseline.app/startups"
  },
  "actions": {
    "advance": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY/advance",
    "build": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY/build",
    "claim": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY/claim"
  }
}

Startup.list

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

Text
GET /{namespace}/startups

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
startupslist of StartuprequiredOne page of Startups.

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

Startup

Previous

update, delete

Next