Create Folder
Create a folder in a workspace.
Requires a user API key — you must be a writable member of the workspace.
A team-only API key returns 401.
To nest the folder, set parentId (folders can be nested up to 5 levels below the root level).
sharingType defaults to ALL_MEMBER_VIEWER when omitted.
인증
API key in format {id}.{secret}
경로 매개변수
Workspace GUID. Obtain it from GET /v1/external/workspaces.
본문
Create a folder in a workspace.
Folder title. Must not be blank.
1 - 50"Q1 2025 Meetings"
Who can access a folder and the notes inside it.
| Type | View | Edit |
|---|---|---|
PRIVATE | Only you | Only you |
ALL_MEMBER_VIEWER | All workspace members | No member-wide edit access |
ALL_MEMBER_EDITOR | All workspace members | All workspace members |
LIMITED | Invited members only | Invited members only (per-member role) |
PRIVATE: Personal folder. Not shared with the workspace.ALL_MEMBER_VIEWER: Every workspace member can view; no member-wide edit access is granted.ALL_MEMBER_EDITOR: Every workspace member can view and edit.LIMITED: Only explicitly invited members can access, each with an individual role (VIEWERorEDITOR).
PRIVATE, ALL_MEMBER_VIEWER, ALL_MEMBER_EDITOR, LIMITED "PRIVATE"
Parent folder ID for a nested folder. Omit or set to null to create at
the root level. Folders can be nested up to 5 levels below the root level.
"12300"
Folder description. Defaults to an empty string.
"Daily engineering standup notes"
Folder color in hex format (#RRGGBB). Defaults to #737373.
^#[0-9A-Fa-f]{6}$"#27AE60"
응답
Folder created
A folder and its metadata.
Unique identifier for the folder
"12345"
GUID of the workspace the folder belongs to
"ws_a1b2c3d4"
Folder title (max 50 characters)
"Weekly Team Meetings"
Folder description. Empty string when unset.
"Notes from our weekly sync"
Who can access a folder and the notes inside it.
| Type | View | Edit |
|---|---|---|
PRIVATE | Only you | Only you |
ALL_MEMBER_VIEWER | All workspace members | No member-wide edit access |
ALL_MEMBER_EDITOR | All workspace members | All workspace members |
LIMITED | Invited members only | Invited members only (per-member role) |
PRIVATE: Personal folder. Not shared with the workspace.ALL_MEMBER_VIEWER: Every workspace member can view; no member-wide edit access is granted.ALL_MEMBER_EDITOR: Every workspace member can view and edit.LIMITED: Only explicitly invited members can access, each with an individual role (VIEWERorEDITOR).
PRIVATE, ALL_MEMBER_VIEWER, ALL_MEMBER_EDITOR, LIMITED "PRIVATE"
Parent folder ID. null for root-level folders. In the List Folders
response, parentId is also null when the parent folder is not
accessible to you.
"12300"
Folder color in hex format (#RRGGBB)
"#4A90D9"
true when the folder is shared with the workspace (any sharingType
except PRIVATE); false for PRIVATE folders. Retained for backward
compatibility — use sharingType for the precise access level.
true
ISO-8601 creation timestamp (UTC)
"2025-01-15T10:30:00Z"
ISO-8601 last-update timestamp (UTC)
"2025-01-18T14:20:00Z"