Skip to main content
GET
List Workspace Notes

인증

Authorization
string
header
필수

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.

경로 매개변수

workspaceGuid
string
필수

Workspace GUID. Obtain it from GET /v1/external/workspaces.

쿼리 매개변수

cursor
string

Cursor for the next page

size
integer
기본값:100

Page size (default 100, max 200)

필수 범위: 1 <= x <= 200
keyword
string

Optional keyword for a shallow full-text search. When present, results are reordered by relevance and bounded by what the search index returns; nextCursor is always null in this mode (single page). Combine with folderId and createdAtFrom / createdAtTo to narrow the results. For deep search that also returns note documents, use POST /v1/external/workspaces/{workspaceGuid}/notes/search instead. Requires a user-scoped API key.

folderId
string

Restrict to notes inside a specific folder. Includes descendant folders (recursive). The folder must belong to this workspace.

createdAtFrom
string<date-time>

ISO 8601 datetime — return only notes with createdAt >= this value.

createdAtTo
string<date-time>

ISO 8601 datetime — return only notes with createdAt < this value.

응답

List of notes in the workspace

content
object[]
필수

Array of items for current page

nextCursor
string | null
필수

Cursor for next page, null if last page

예시:

"opaque-cursor-string"