SearchResultGroup

A request or response body; the type column links to the schemas it refers to.

SearchResultGroup

FieldTypeRequiredDescription
titlestringyes—
hitsarray of SearchHityes—
truncatedbooleanyes

True when more rows matched than the group carries (five).

view_all_hrefstringyes

The list page a truncated group points onward to.

jsonExample
{
  "title": "Learning records",
  "hits": [
    {
      "key": "6f3b34d8-…",
      "name": "Welding safety induction",
      "href": "/records/6f3b34d8-3c5e-4dd9-9f4e-2b52f0d9a1c7",
      "context": "Jordan Lee",
      "badges": []
    }
  ],
  "truncated": true,
  "view_all_href": "/records?q=welding"
}