list_workspaces - Tiro Docs

개요

list_workspaces는 API Key가 접근할 수 있는 워크스페이스 목록을 반환해요. 각 워크스페이스의 guid를 노트, 폴더, 위키 도구의 workspaceGuid로 전달해요. 파라미터와 scope는 필요하지 않아요.

응답 형식

{
  "workspaces": [
    { "guid": "1a2b3c4d5e6f7", "name": "Acme", "isWikiEnabled": true },
    { "guid": "7f6e5d4c3b2a1", "name": "Personal", "isWikiEnabled": false }
  ]
}

Field	Type	Description
`workspaces[].guid`	string	워크스페이스 GUID. 다른 도구의 `workspaceGuid`에 그대로 전달해요
`workspaces[].name`	string	워크스페이스 이름
`workspaces[].isWikiEnabled`	boolean	요금제가 위키를 지원하고 관리자가 위키를 켠 워크스페이스면 `true`. 위키 도구에는 `true`인 워크스페이스의 `guid`를 전달해요

사용자 범위 key와 OAuth 토큰은 사용자가 속한 모든 워크스페이스를, 워크스페이스 범위 key는 연결된 워크스페이스 하나를, 조직 key는 조직의 워크스페이스를 반환해요.

`workspaceGuid`를 받는 도구는 무엇인가요?

list_workspaces에서 얻은 guid는 아래 도구의 workspaceGuid로 전달해요.

list_notes, search_notes: 선택. 검색 범위를 한 워크스페이스로 좁혀요
search_private_folders, search_team_folders: 필수
search_wiki, get_wiki_page, list_wiki_mentions, get_wiki_graph: 필수

예시: 워크스페이스의 노트 검색하기

{
  "keyword": "분기 계획",
  "workspaceGuid": "1a2b3c4d5e6f7"
}