Skip to main content
GET
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:50

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

Required range: 1 <= x <= 100
page
string | null

Opaque cursor from a previous list response. Omit for the first page. IMPORTANT: Reuse with the same filters and order_by settings.

order_by
enum<string>
default:updated_at

Sort key for pagination boundaries. Use updated_at (default) for recency feeds. Use created_at for creation-order views.

Available options:
created_at,
updated_at
collection_id
string<uuid> | null

Optional collection filter by UUID. When set, only notes linked to this collection are returned.

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.

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.

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.

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.

contains_open_tasks
boolean
default:false

When true, include notes that contain at least one open task item. When multiple contains_* fields are true, notes matching any selected filter may be returned.

contains_tasks
boolean
default:false

When true, include notes that contain at least one task item (open or closed). When multiple contains_* fields are true, notes matching any selected filter may be returned.

contains_images
boolean
default:false

When true, include notes that contain image media (including image and GIF kinds). When multiple contains_* fields are true, notes matching any selected filter may be returned.

contains_files
boolean
default:false

When true, include notes that contain file-like attachments (including file and PDF kinds). When multiple contains_* fields are true, notes matching any selected filter may be returned.

include_note_content
boolean
default:false

When true, include full markdown content for each returned note. IMPORTANT: This increases payload size and can increase latency.

Response

200 - application/json

OK

request_id
string
required

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

results
NoteListItemResponseSchema · object[]
required

Page of note results matching the requested filters and sort.

total
integer
required

Total number of matching notes before pagination is applied.

next_page
string | null

Opaque cursor for the next page of results. Omitted when there are no more results.