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

Content routes: create, get, list

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

Reference for Content, one group of Content routes.

Content.create

Creates a Content. Verb page.

Text
POST /{namespace}/content

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

Inputs

InputTypeRequiredDescription
titlestringrequiredThe headline.
publishedAtdatetimeWhen it went live.
kindstringWhat the Content is, so each System reads its own kind.

Returns

OutputTypeRequiredDescription
contentContentrequiredThe Content.

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

Content.get

Returns one Content by id. Verb page.

Text
GET /{namespace}/content/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
contentContentrequiredThe Content.

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/content/content_HYlnoorBdP \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Content",
  "$id": "https://api.sb/leaseline.app/content/content_HYlnoorBdP",
  "content": {
    "$id": "https://api.sb/leaseline.app/content/content_HYlnoorBdP",
    "$type": "Content",
    "title": "Leaseline Pro"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/content/content_HYlnoorBdP",
    "up": "https://api.sb/leaseline.app/content"
  },
  "actions": {
    "publish": "https://api.sb/leaseline.app/content/content_HYlnoorBdP/publish"
  }
}

Content.list

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

Text
GET /{namespace}/content

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
contentlist of ContentrequiredOne page of Content.

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

Content

Previous

update, delete

Next