Search Articles
Full search across a help center's published articles, returning complete articles ranked by relevance plus a totalCount. Set highlight to also receive the matched fragments of each title and summary, ready to render as emphasised text. This endpoint is public, so it always restricts to published articles no matter what state is sent.
Authorization
Authorization In: header
Query Parameters
ID of the help center to search within.
Also return a highlights array marking which parts of each title and summary matched, as alternating plain/highlight fragments ready to render.
The search text.
Which articles to search. The public Search Articles endpoint forces published regardless of what is sent here.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://www.saasco.com/api/v2/knowledge/search?helpCenterId=string&phrase=string"{
"articles": [
{
"id": "string",
"createdAt": "string",
"updatedAt": "string",
"projectId": "string",
"type": "public",
"title": "string",
"slug": "string",
"description": "string",
"body": "string",
"url": "string",
"state": "draft",
"order": -9007199254740991,
"collectionId": "string",
"authorId": "string",
"views": -9007199254740991,
"conversions": -9007199254740991,
"happyReactions": -9007199254740991,
"neutralReactions": -9007199254740991,
"sadReactions": -9007199254740991,
"author": {
"id": "string",
"image": "string",
"name": "string"
},
"collection": {
"helpCenterId": "string",
"name": "string"
}
}
],
"highlights": [
{
"articleId": "string",
"highlightedSummary": [
[
{
"text": "string",
"type": "plain"
}
]
],
"highlightedTitle": [
{
"text": "string",
"type": "plain"
}
]
}
],
"totalCount": 0
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Get Related Articles
Suggests further reading for an article, for a "related articles" block at the foot of a help-center page. Relatedness is text similarity: the source article's title and description are matched against other articles in the same help center. Only published public articles are considered on both sides, so an unpublished or internal source article returns an empty list rather than an error. Defaults to 5 results.
Instant Search Articles
Type-ahead search for a help-center search box. Returns at most 5 published public articles as lightweight hits (title, slug, collection name, and a short snippet) with `totalCount` reporting how many matched overall so you can offer "see all results". Falls back to fuzzy matching when the phrase is too short or malformed for full-text search, so partial words and typos still return something. Use Search Articles for the full result page.