Documentation search

Search the guides or API reference used by the documentation navigation.

GET /api/search

Public, read-only full-text search powered by Fumadocs. No session is required.

Query parameterMeaning
querySearch text.
scopeguides or api. Defaults to guides.

Both collections are available on the documentation host. The navigation selects guides for guides and the changelog, or api for the API reference. The explicit scope works the same way on local, preview and configured documentation hosts; it is not overridden by the hostname.

An unsupported scope returns HTTP 400 with {"error":"Unknown documentation scope"}.

If the API cannot reach the configured documentation origin within ten seconds, it returns the API-wide error envelope with HTTP 502.

A successful response is a JSON array of Fumadocs search results, with id, type, content and url fields. Results link to canonical paths: /developer/... for guides and /developer/api/... for API reference.

GET /api/search?scope=api&query=check-in

This endpoint searches documentation only. It does not search event records, attendees or account data.

On this page