View as Markdown
Airbyte icon

Airbyte ACTION

List Workspaces

Lists workspaces on Airbyte. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Airbyte account once, then configure and run List Workspaces from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "https_airbyte_com-list-workspaces",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    https_airbyte_com: { authProvisionId: "apn_xxxxxxx" },
    includeDeleted: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Workspaces inputs
Property Type Description
includeDeleted Include Deleted boolean
Include deleted workspaces in the list
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
https_airbyte_com-list-workspaces
Version
0.0.3
App
Airbyte
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes