Skip to main content

Search content

GET /cms/{type}/{language}
GET /internal/cms/{type}/{language}
alphahttps://api.sandbox.ovok.com

Search Content

Search and paginate CMS content entries for a given content type and language.
Results are sorted by date (newest first). An optional free-text search performs fuzzy matching across title, author, category, section titles, section text, and key.

Path Parameters

ParameterDescriptionExample
typeContent type (e.g. article, faq, exercise)article
languageISO language codeen-US

Query Parameters

ParameterTypeDescriptionDefault
searchstringFree-text fuzzy search term-
codestringFilter by content code-
_countnumberPage size10
_offsetnumberNumber of items to skip0

Example cURL request

curl -X GET \
--url 'https://api.dev.ovok.com/cms/article/en-US?search=Blog&_count=20&_offset=0' \
-H 'Authorization: Bearer <token>'

Response

{
"total": 42,
"resources": [
{
"id": "composition-id",
"title": "My Blog",
"category": "123",
"section": [],
"language": "en-US",
"key": "article-my-blog-a1b2c3d4",
"type": "article",
"date": "2025-01-15T12:00:00.000Z",
"author": {
"reference": "Practitioner/abc",
"display": "Dr. Smith"
}
}
]
}

Notes: The fuzzy search uses Fuse.js. When no search term is provided, all entries for the given type and language are returned, paginated by _count and _offset.

Parameters

NameInTypeRequiredDescription
typepathstringyes
languagepathstringyes
searchquerystringno
codequerystringno
_countquerystringno
_offsetquerystringno

Responses

CodeDescription
200Success.
400The request could not be operated by the server.
401The resource owner or authorization server denied the request.
404The requested resource could not be found.
422The request could not be validated by the server.
500The server encountered an unexpected condition. Please try again later.