Skip to main content

Get a published item

GET /v1/public/cms/{typeSlug}/items/{idOrSlug}
devhttps://api.sandbox.ovok.com

Fetch a single published item by id or slug. Authenticates with a project-scoped API key. Returns 404 for drafts, unpublished items, or items in another project.

Parameters

NameInTypeRequiredDescription
typeSlugpathstringyesCollection slug as defined in the project's Payload schema (e.g. posts, services).
idOrSlugpathstringyesEither the Payload item id or the collection's slug field. The handler tries id first, then slug.
localequerystringnoBCP-47-ish locale (e.g. en, en-GB). Falls back to the project default when unset or unmatched.
depthquerystringnoRelationship resolve depth, 0–5. Higher values resolve more nested relations at the cost of extra round-trips.

Responses

CodeDescription
200Success.

200PublicDeliveryItemResponseDto (application/json)

Published CMS item. Shape is project- and collection-specific — the documented fields are the envelope guaranteed by the delivery API; everything else comes from the Payload collection schema.

  • id: string (required) — Stable Payload item id.
  • slug: string — Slug for the item, when the collection defines a slug field.
  • publishedAt: string — ISO-8601 timestamp the item was last published. Items without this field are filtered out of the response.

Additional properties allowed.

Example

{
"id": "87ea5dfc-8b8e-384d-8489-79496e706390",
"slug": "welcome-banner",
"publishedAt": {},
"title": "Welcome to Ovok",
"body": "Long-form content authored in the Console."
}