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

Post routes: create, get, list

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

Reference for Post, one group of Post routes.

Post.create

Creates a Post. Verb page.

Text
POST /{namespace}/posts

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

Inputs

InputTypeRequiredDescription
formatstringrequiredThe venue’s format, such as shortVideo or thread.
publishAtdatetimeWhen it goes out.
claimsjsonThe facts it states, each resolving to a record.
reachintegerHow many people saw it, as the venue reports.
handleHandleEvery Post goes out from one Handle, so its reach and replies count toward that Handle.

Returns

OutputTypeRequiredDescription
postPostrequiredThe Post.

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/posts \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format":"Example format"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "post": {
    "$id": "https://api.sb/leaseline.app/posts/post_HiXn57rBdP",
    "$type": "Post",
    "format": "Example format",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Post.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Post.get

Returns one Post by id. Verb page.

Text
GET /{namespace}/posts/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
postPostrequiredThe Post.

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/posts/post_HiXn57rBdP \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Post",
  "$id": "https://api.sb/leaseline.app/posts/post_HiXn57rBdP",
  "post": {
    "$id": "https://api.sb/leaseline.app/posts/post_HiXn57rBdP",
    "$type": "Post",
    "format": "Example format",
    "status": "draft"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/posts/post_HiXn57rBdP",
    "up": "https://api.sb/leaseline.app/posts"
  },
  "actions": {
    "publish": "https://api.sb/leaseline.app/posts/post_HiXn57rBdP/publish",
    "schedule": "https://api.sb/leaseline.app/posts/post_HiXn57rBdP/schedule",
    "withdraw": "https://api.sb/leaseline.app/posts/post_HiXn57rBdP/withdraw"
  }
}

Post.list

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

Text
GET /{namespace}/posts

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
postslist of PostrequiredOne page of Posts.

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

Post

Previous

update

Next