Search notes by criteria

GET/api/search/note

Returns matching notes within joined projects. result=ids returns all matching note ids; result=items returns paged display summaries. Multiple tag values are OR-ed. The literal value "none" means the note has no tags. WIP notes are included by default (includeWip=false to exclude).

Parameters

projectId"@all" | integerqueryRequired: A project ID, or @all for every open project you belong to.
qstringquery: Keywords to search for in the note title and body (up to 200 characters). Separate keywords with spaces (up to 5); a note must match all of them.
tagIdsstringquery: Comma-separated tag IDs (up to 100). none matches notes without tags.
tagModeand | excludequery: How to apply tagIds. and returns notes that have any of the tags; exclude returns notes that do not. Defaults to and.
includeWip0 | 1 | true | falsequery: Whether to include work-in-progress notes: true, false, 1 or 0. Defaults to true.
resultids | itemsquery: Shape of the response. ids returns matching note IDs; items returns note summaries, 30 per page. Defaults to ids.
pageintegerquery: Page number, starting at 1. Used only when result is items.

Responses

200Matching notes ({ noteIds, truncated } or { items, hasMore })
400Invalid query
401Authentication is required