list_workspaces - Tiro Docs

概要

list_workspaces は、API Key がアクセスできるワークスペースの一覧を返します。各ワークスペースの guid を、ノート・フォルダ・Wiki ツールの 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	プランが Wiki に対応し、管理者が Wiki を有効にしているワークスペースでは `true`。Wiki ツールには `true` のワークスペースの `guid` を渡します

user-scoped key と OAuth トークンはユーザーが所属するすべてのワークスペースを、workspace-scoped key は接続されているワークスペース 1 つを、組織 key は組織のワークスペースを返します。

`workspaceGuid` を受け取るツールはどれですか？

list_workspaces で取得した guid は、以下のツールの workspaceGuid として渡します。

list_notes、search_notes: 任意。検索範囲を 1 つのワークスペースに絞ります
search_private_folders、search_team_folders: 必須
search_wiki、get_wiki_page、list_wiki_mentions、get_wiki_graph: 必須

例: ワークスペースのノートを検索する

{
  "keyword": "四半期計画",
  "workspaceGuid": "1a2b3c4d5e6f7"
}