SynapSynapDocs
Hub REST API

Public

The Public operations of the Hub REST API (3 operations).

For BuildersOpen-source podSynap CloudGenerated from Synap-core/backend@c31e261ab (main)
GET
/public/projection

Query Parameters

workspace*string

Target workspace id (uuid).

q?string

Optional keyword filter (matched on title + preview).

role?string

Optional single facet role slug to narrow to. Ignored unless it is within the workspace's configured public role allowlist.

limit?string

Page size. Default 20, hard-capped at 50.

Response Body

Field-whitelisted projection items

application/json
  1. response
items*array<>
count*number
Example Request
curl -X GET 'https://pod.example.com/api/hub/public/projection?workspace=string'
Example Response
{  "items": [    {      "id": "string",      "title": "string",      "role": "string",      "properties": {        "property1": null,        "property2": null      }    }  ],  "count": 0}
GET
/public/shares/{token}

Path Parameters

token*string

The public share token (the capability). Stored hashed; every miss is the same 404.

Response Body

The published share

application/json
  1. response
resourceType*"entity"
Value in"entity"
title?string

Present only when the publisher allowlisted title.

properties*

The publish-time snapshot of allowlisted values (plain values only; internal ids removed).

body*|

The pinned published revision's text, or null.

publishedOn*string

Publication day, YYYY-MM-DD.

Example Request
curl -X GET 'https://pod.example.com/api/hub/public/shares/string'
Example Response
{  "resourceType": "entity",  "title": "string",  "properties": {    "property1": "string",    "property2": "string"  },  "body": {    "format": "markdown",    "content": "string"  },  "publishedOn": "string"}
GET
/public/sites/{siteToken}

Path Parameters

siteToken*string

The site token (the capability). Stored hashed; every miss is the same 404.

Response Body

The site manifest

application/json
  1. response
title?string

Present only when the owner's policy publishes title.

description?string

Present only when the owner's policy publishes description.

publishedOn*string

Day the site went live, YYYY-MM-DD.

collections*array<>
Example Request
curl -X GET 'https://pod.example.com/api/hub/public/sites/string'
Example Response
{  "title": "string",  "description": "string",  "publishedOn": "string",  "collections": [    {      "key": "string",      "count": 0,      "sort": [        "string"      ],      "pageSize": 0,      "addressing": "slug"    }  ]}