API reference

Public content API

Reference for the unauthenticated, published-content read endpoint.

Request

GET https://api.preview.govcms.one/v1/public/institutions/content
  ?siteId={uuid}&type=news&page=1&pageSize=12

Public reads need no API key. Confirm the production API host with GovCMS.

Query parameters

Parameter	Purpose	Constraints
`siteId`	Provisioned site UUID	UUID
`site` / `slug`	Institution profile slug	String
`type`	Content type	page, news, publication, leadership, procurement
`page`	Result page	1–10000; default 1
`pageSize`	Records per page	1–100; default 100
`category`	Metadata category	Up to 120 chars
`slug`	Exact record lookup	Up to 255 chars
`excludeSlug`	Exclude exact slug	Up to 255 chars

Response shape

{
  "status": "success",
  "data": {
    "site": { "id": "…", "name": "…", "slug": "…" },
    "records": [{ "id": "…", "type": "news", "slug": "…",
      "title": "…", "summary": "…", "body": "<p>…</p>",
      "status": "published", "metadata": {}, "publishedAt": "…" }],
    "categories": [],
    "pagination": { "page": 1, "pageSize": 12, "total": 1,
      "totalPages": 1, "hasNextPage": false, "hasPreviousPage": false }
  }
}

Optional properties may be null. Metadata varies by type.

Validation and empty results

Invalid UUID, page or pageSize returns HTTP 400 with a message. Unknown sites return HTTP 200 with data.site null. Handle failures and empty results separately.

Previous← Publishing workflow NextContent records →