list_workspaces - Tiro Docs

Overview

list_workspaces returns the workspaces your API Key can access. Pass a workspace’s guid as the workspaceGuid of the note, folder, and wiki tools. It takes no parameters and requires no scope.

Response format

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

Field	Type	Description
`workspaces[].guid`	string	Workspace GUID. Pass it as-is to another tool’s `workspaceGuid`
`workspaces[].name`	string	Workspace name
`workspaces[].isWikiEnabled`	boolean	`true` when the workspace’s plan includes wiki and an admin has turned it on. Pass the wiki tools the `guid` of a workspace where it is `true`

A user-scoped key or OAuth token returns every workspace the user belongs to; a workspace-scoped key returns the one workspace it is connected to; an organization key returns the organization’s workspaces.

Which tools accept `workspaceGuid`?

Pass a guid from list_workspaces as the workspaceGuid of the tools below.

list_notes, search_notes: optional. Narrows the search to one workspace
search_private_folders, search_team_folders: required
search_wiki, get_wiki_page, list_wiki_mentions, get_wiki_graph: required

Example: search notes in a workspace

{
  "keyword": "quarterly plan",
  "workspaceGuid": "1a2b3c4d5e6f7"
}