View as Markdown
Confluence icon

Confluence ACTION

Get Page by ID

Retrieve a page by its ID. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Confluence account once, then configure and run Get Page by ID 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-get-page-by-id",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    confluence: { authProvisionId: "apn_xxxxxxx" },
    pageId: "Page ID",
    bodyFormat: "Body Format",
  },
})

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.

Get Page by ID inputs
Property Type Description
pageId Page ID string
Select a page or provide its ID
Required Dynamic
bodyFormat Body Format string
The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
Optional
getDraft Get Draft boolean
If true, retrieves the draft version of this page.
Optional
status Status string[]
Filter the page being retrieved by its status.
Optional
version Version integer
Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
Optional
additionalOptions Additional Options object
Additional parameters to send in the request. See the documentation for available parameters. Values will be parsed as JSON where applicable.
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-get-page-by-id
Version
0.1.1
App
Confluence
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes