Skip to main content
GET
Search Wiki Mentions

Authorizations

Authorization
string
header
required

API key in format {id}.{secret}.

The notes an endpoint returns depend on the key type. A user key reaches the notes that user can see in the app, including notes in their own private folders. A system key (workspace or organization, no user identity) reaches only notes that sit in a folder shared with all workspace members. Notes in a private folder, in a folder shared with only some members, or in no folder at all fall outside a system key's read scope, and scopes do not widen that boundary.

List and search endpoints drop out-of-scope notes from the response without an error. Single-note reads and their sub-resources return 404, the same response as a deleted note. See What notes a system key reads.

Path Parameters

workspaceGuid
string
required

Workspace GUID

Query Parameters

q
string
required

Search keyword (required)

size
integer
default:20

Result size (default 20, max 100)

Required range: 1 <= x <= 100

Response

Ranked list of matching mentions

items
object[]
required

Ranked list of matching mentions