View as Markdown
Confluence icon

Confluence ACTION

List Spaces

List all spaces in Confluence. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Confluence account once, then configure and run List Spaces 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: "confluence-list-spaces",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    confluence: { authProvisionId: "apn_xxxxxxx" },
    ids: ["IDs"],
    keys: ["Keys"],
  },
})

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 Spaces inputs
Property Type Description
ids IDs string[]
Filter results to spaces with these numeric IDs. Accepts up to 250 IDs. Example: [123456, 789012]
Optional Dynamic
keys Keys string[]
Filter results to spaces with these space keys. Accepts up to 250 keys. Example: ["ENG", "MKTG"]
Optional
type Type string
Filter results to spaces of this type. Example: "global"
Optional
spaceStatus Status string
Filter results to spaces with this status. Use current for active spaces or archived for archived ones. Example: "current"
Optional
labels Labels string[]
Filter results to spaces that have all of these labels applied. Accepts up to 250 labels. Example: ["team-docs", "public"]
Optional
sort Sort string
Field to sort results by. Prefix with - for descending order. Example: "-name" (Z to A by name)
Optional
descriptionFormat Description Format string
Content format for the description field in the response. Use plain for plain text or view for rendered HTML. Example: "plain"
Optional
includeIcon Include Icon boolean
Whether to include the space icon in the response. Example: true
Optional
cursor Cursor string
Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
Optional
limit Limit integer
Maximum number of spaces to return per request (1–250). Use the cursor from the Link response header to retrieve the next page. Example: 25
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
confluence-list-spaces
Version
0.0.2
App
Confluence
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes