Skip to main content
GET
Keyword search over documentation pages.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Query Parameters

q
string
required

Keywords to search the documentation for

limit
integer
default:5

Maximum number of results (default: 5, max: 50)

snippetChars
integer
default:300

Approximate length of each matching snippet (default: 300)

maxSnippets
integer
default:3

Maximum snippets returned per page (default: 3)

Response

Keyword search results

Keyword search results. Fetch a full page with GET /api/v0/documentation/{id}.

query
string

Original query

results
object[]