Skip to content
Open Markdown

Get published site configuration ​

GET /v1/public/site

  • Operation ID: getPublicSite
  • Tags: Public site
  • Base URL: http://localhost:8787

Anonymous read of the published subset only: public settings sections, resolved feature flags, published content blocks, published navigation and active announcements. Drafts are never returned. surface narrows content blocks and navigation to one app.

Workflow: Integration guide.

Authentication: none (public).

Authentication ​

  • Auth: none (public endpoint, no token required).

Parameters ​

NameInTypeRequiredDescription
surfacequerystringnoOne of: "landing", "portal"

Responses ​

200 ​

Published site configuration.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (PublicSiteConfig)

FieldTypeRequiredDescription
settingsobjectyesPublic settings sections keyed by section name; only sections flagged public.
flagsobjectyesFeature flags resolved to on/off; audience and rollout rules are never exposed.
contentBlocks(object (PublicContentBlock))[]yes-
contentBlocks[].idstring<uuid>yes-
contentBlocks[].surfacestringyes-
contentBlocks[].slotstringyes-
contentBlocks[].localestringyes-
contentBlocks[].sort_orderintegeryes-
contentBlocks[].publishedobjectyesPublished content payload of the block.
contentBlocks[].versionintegeryes-
contentBlocks[].published_atstring<date-time>yesISO timestamp.
navigation(object (PublicNavItem))[]yes-
navigation[].idstring<uuid>yes-
navigation[].surfacestringyes-
navigation[].locationstringyes-
navigation[].parent_idstring<uuid> | nullyes-
navigation[].labelstringyes-
navigation[].hrefstringyes-
navigation[].sort_orderintegeryes-
announcements(object (PublicAnnouncement))[]yesCurrently active announcements, newest first.
announcements[].idstring<uuid>yes-
announcements[].kindstringyes-
announcements[].surfacesstring[]yes-
announcements[].severitystringyes-
announcements[].titlestringyes-
announcements[].body_mdstring | nullyes-
announcements[].cta_labelstring | nullyes-
announcements[].cta_urlstring | nullyes-
announcements[].dismissiblebooleanyes-
announcements[].starts_atstring<date-time>yes-
announcements[].ends_atstring<date-time> | nullyes-

Errors ​

400 ​

Request validation failed.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody)

FieldTypeRequiredDescription
successbooleanyesOne of: false
errorobjectyes-
error.namestringyesOne of: "ZodError"
error.issuesobject[]yes-
error.issues[].codestringyes-
error.issues[].path(string | number)[]yes-
error.issues[].messagestringyes-

Request validation

json
{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

500 ​

Unexpected server error (internal). No details are returned.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

FieldTypeRequiredDescription
errorstringyesStable machine-readable error code, e.g. forbidden, not_found.
detailsanynoOptional structured context. For 403 it is { perm }.

Error response

json
{
  "error": "internal"
}

Examples ​

curl ​

bash
curl -X GET 'http://localhost:8787/v1/public/site'

TypeScript ​

ts
const response = await fetch("http://localhost:8787/v1/public/site", {
  method: "GET",
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();

Try this endpoint

Requests go directly from your browser to the API. Send request executes this endpoint against the selected server.

GET/v1/public/site

Your token stays in this tab's memory and is sent only when you press Send request.

Parameters

Built for developers. Ready for agents.