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

Startup Template routes: create, get, list

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

Reference for Startup Template, one group of Startup Template routes.

StartupTemplate.create

Creates a Startup Template. Verb page.

Text
POST /{namespace}/startup-templates

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

Inputs

InputTypeRequiredDescription
slugstringrequiredThe argument to create --template and the page path under /start/templates.
operatingModelstringrequiredThe human and Agent mix: autonomous, single-human, or multi-human.
motionsstring[]requiredThe Motions its Offers sell through, such as b2b or b2a.
extendsStartup TemplateThe base Startup Template whose Product Templates, Systems, Processes, and Roles it inherits.

Returns

OutputTypeRequiredDescription
startupTemplateStartup TemplaterequiredThe Startup Template.

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/startup-templates \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"leaseline","operatingModel":"autonomous","motions":["Example motions"]}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "startupTemplate": {
    "$id": "https://api.sb/leaseline.app/startup-templates/stpl_9OivLWR17L",
    "$type": "StartupTemplate",
    "slug": "leaseline",
    "operatingModel": "autonomous",
    "motions": [
      "Example motions"
    ]
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "StartupTemplate.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

StartupTemplate.get

Returns one Startup Template by id. Verb page.

Text
GET /{namespace}/startup-templates/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
startupTemplateStartup TemplaterequiredThe Startup Template.

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/startup-templates/stpl_9OivLWR17L \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "StartupTemplate",
  "$id": "https://api.sb/leaseline.app/startup-templates/stpl_9OivLWR17L",
  "startupTemplate": {
    "$id": "https://api.sb/leaseline.app/startup-templates/stpl_9OivLWR17L",
    "$type": "StartupTemplate",
    "slug": "leaseline",
    "operatingModel": "autonomous",
    "motions": [
      "Example motions"
    ]
  },
  "links": {
    "self": "https://api.sb/leaseline.app/startup-templates/stpl_9OivLWR17L",
    "up": "https://api.sb/leaseline.app/startup-templates"
  },
  "actions": {
    "extend": "https://api.sb/leaseline.app/startup-templates/stpl_9OivLWR17L/extend",
    "promote": "https://api.sb/leaseline.app/startup-templates/stpl_9OivLWR17L/promote",
    "upgrade": "https://api.sb/leaseline.app/startup-templates/stpl_9OivLWR17L/upgrade"
  }
}

StartupTemplate.list

Returns Startup Templates, newest first, one page at a time. Verb page.

Text
GET /{namespace}/startup-templates

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
startupTemplateslist of Startup TemplaterequiredOne page of Startup Templates.

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/startup-templates?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "StartupTemplate",
  "startupTemplates": [
    {
      "$id": "https://api.sb/leaseline.app/startup-templates/stpl_9OivLWR17L",
      "$type": "StartupTemplate",
      "slug": "leaseline",
      "operatingModel": "autonomous",
      "motions": [
        "Example motions"
      ]
    }
  ],
  "meta": {
    "limit": 20,
    "after": "stpl_9OivLWR17L"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/startup-templates?limit=20",
    "next": "https://api.sb/leaseline.app/startup-templates?after=stpl_9OivLWR17L"
  }
}

Startup Template

Previous

update, delete

Next