OpenMax
Free Trial

Apps API · KB Search

KB Search: 1 endpoints

← All groups

GET /api/v1/search/pages

Search pages

Scope: kb:page:read · Called with: appToken · operationId: search-pages

Required app scope: kb:page:read.

Searches KB pages. Response wrapped in standard envelope. pagination.total_count is an upper bound for this search: hits the caller cannot see (deleted pages or knowledge bases, pages the caller may not read) are dropped from each page after they were counted, so a page can hold fewer items than limit and fewer items than total_count may be returned in all.

Parameters

Name In Type Required Description
kb_id query string (uuid) KB UUID
query query string Search query
limit query integer (int32) Items per page (default: 20, max: 100)
offset query integer (int32) Number of items to skip (default: 0)
sort query string Sort expression

Responses