Skip to content

List workspaces

The workspaces of the caller's organization (a client or brand each), oldest first: each with its id, name, current (the one requests act in when they name no workspace) and locked (past the plan's workspaces: it can't be read or changed). Saves, notes, boards and follows belong to one workspace; pass its id or exact name as workspace to the endpoints that take one. Same answer as the MCP tool list_workspaces. Never counted against the allowance, as its MCP tool; the account still needs a plan (402 no_plan without one).

get/api/v1/workspaces

Authentication

OAuth token, API key or signed-in session, sent as Authorization: Bearer <token> (a session rides on its cookie). An OAuth token needs mcp:read. See authentication.

Response fields

  • workspacesarray of object

    Each with id, name, current, locked.

  • urlstring (uri)

    The organization's settings in the app.

Responses

  • 200

    The organization's workspaces. Body: WorkspaceList.

  • 401

    No account: send an API key, an OAuth access token or a session cookie. WWW-Authenticate names the protected-resource metadata. Body: Problem.

  • 402

    no_plan: the account has no plan, and the API comes with one. Body: Problem.

  • 403

    The token lacks mcp:read. Body: Problem.

  • 429

    Rate limit exceeded; wait Retry-After seconds. Body: Problem.

  • 500

    The request failed on our side. Body: Problem.