메인 콘텐츠로 건너뛰기
GET
/
v1
/
external
/
folders
/
{folderId}
Get Folder
curl --request GET \
  --url https://api.tiro.ooo/v1/external/folders/{folderId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "12345",
  "workspaceGuid": "ws_a1b2c3d4",
  "title": "Weekly Team Meetings",
  "description": "Notes from our weekly sync",
  "sharingType": "ALL_MEMBER_VIEWER",
  "parentId": null,
  "color": "#4A90D9",
  "isTeamFolder": true,
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-18T14:20:00Z"
}

인증

Authorization
string
header
필수

API key in format {id}.{secret}

경로 매개변수

folderId
string
필수

Folder ID

응답

Folder details

A folder and its metadata.

id
string
필수

Unique identifier for the folder

예시:

"12345"

workspaceGuid
string
필수

GUID of the workspace the folder belongs to

예시:

"ws_a1b2c3d4"

title
string
필수

Folder title (max 50 characters)

예시:

"Weekly Team Meetings"

description
string
필수

Folder description. Empty string when unset.

예시:

"Notes from our weekly sync"

sharingType
enum<string>
필수

Who can access a folder and the notes inside it.

TypeViewEdit
PRIVATEOnly youOnly you
ALL_MEMBER_VIEWERAll workspace membersNo member-wide edit access
ALL_MEMBER_EDITORAll workspace membersAll workspace members
LIMITEDInvited members onlyInvited 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 (VIEWER or EDITOR).
사용 가능한 옵션:
PRIVATE,
ALL_MEMBER_VIEWER,
ALL_MEMBER_EDITOR,
LIMITED
예시:

"PRIVATE"

parentId
string | null
필수

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"

color
string
필수

Folder color in hex format (#RRGGBB)

예시:

"#4A90D9"

isTeamFolder
boolean
필수

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

createdAt
string<date-time>
필수

ISO-8601 creation timestamp (UTC)

예시:

"2025-01-15T10:30:00Z"

updatedAt
string<date-time>
필수

ISO-8601 last-update timestamp (UTC)

예시:

"2025-01-18T14:20:00Z"