Skip to main content
POST
cURL

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer | null
default:20

Maximum number of notes in this search page. Use smaller values for lower latency. Default is 20; valid range is 1 to 50.

Required range: 1 <= x <= 50
​
offset
integer
default:0

Number of matching notes to skip before returning results. This value is zero-based.

Required range: x >= 0
​
snapshot_id
string<uuid> | null

Opaque search snapshot identifier returned by a previous search page. Required when requesting later pages with offset > 0.

Body

application/json
​
query
string
required

Required text query for relevance matching. The query must contain at least one non-whitespace character. This endpoint does not provide exhaustive chronological pagination; for that, use GET /v2/notes.

Minimum string length: 1
​
config
NoteResultsConfigSchema · object

Configuration flags controlling search response payload shape.

​
filter_by_collection_ids
string<uuid>[] | null

Optional collection UUID filters. When provided, results are limited to notes in any listed collection.

​
filter_by_contains_files
boolean
default:false

When true, include notes that contain file-like attachments (including file and PDF kinds).

​
filter_by_contains_images
boolean
default:false

When true, include notes that contain image media (including image and GIF kinds).

​
filter_by_contains_open_tasks
boolean
default:false

When true, include notes that contain at least one open task item.

​
filter_by_contains_tasks
boolean
default:false

When true, include notes that contain at least one task item (open or closed).

​
filter_by_created_after
string<date-time> | null

Optional inclusive lower bound for note creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

Example:

"2025-04-01T14:30:45Z"

​
filter_by_created_before
string<date-time> | null

Optional inclusive upper bound for note creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

Example:

"2025-04-30T23:59:59Z"

​
filter_by_updated_after
string<date-time> | null

Optional inclusive lower bound for note update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

Example:

"2025-04-01T14:30:45Z"

​
filter_by_updated_before
string<date-time> | null

Optional inclusive upper bound for note update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

Example:

"2025-04-30T23:59:59Z"

Response

200 - application/json

OK

​
has_next_page
boolean
required

Whether another request within the 100-result search window can return more matching notes.

​
limit
integer
required

Limit applied to this search page.

​
offset
integer
required

Zero-based offset applied before returning results.

​
request_id
string
required

Identifier for this API request. Useful for tracing and support.

​
results
NoteSearchItemResponseSchema · object[]
required

Relevance-ranked note results matching the search request.

​
snapshot_id
string<uuid>
required

Opaque snapshot identifier to reuse for deterministic later pages.

​
total
integer
required

Number of matching notes captured in the bounded search snapshot, capped by the 100-result search window.