Get Page by ID with Confluence API

Pipedream makes it easy to connect APIs for Confluence and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Page by ID with the Confluence API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Page by ID with the Confluence API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Page by ID action
1. Connect your Confluence account
2. Select a Page ID
3. Optional- Select a Body Format
4. Optional- Configure Get Draft
5. Optional- Select one or more Status
6. Optional- Configure Version
7. Optional- Configure Additional Options
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Page by ID on Confluence

Description:Retrieve a page by its ID. [See the documentation](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)

Version:0.1.0

Key:confluence-get-page-by-id

View on GitHub

Code#

import confluence from "../../confluence.app.mjs";
import { parseObjectEntries } from "../../common/utils.mjs";
import { BODY_FORMAT_FULL_OPTIONS } from "../../common/constants.mjs";

export default {
  key: "confluence-get-page-by-id",
  name: "Get Page by ID",
  description: "Retrieve a page by its ID. [See the documentation](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)",
  version: "0.1.0",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    confluence,
    pageId: {
      propDefinition: [
        confluence,
        "pageId",
      ],
    },
    bodyFormat: {
      propDefinition: [
        confluence,
        "bodyFormat",
      ],
      options: BODY_FORMAT_FULL_OPTIONS,
    },
    getDraft: {
      type: "boolean",
      label: "Get Draft",
      description: "If true, retrieves the draft version of this page.",
      optional: true,
      default: false,
    },
    status: {
      type: "string[]",
      label: "Status",
      description: "Filter the page being retrieved by its status.",
      optional: true,
      options: [
        "current",
        "archived",
        "trashed",
        "deleted",
        "historical",
        "draft",
      ],
    },
    version: {
      type: "integer",
      label: "Version",
      description: "Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.",
      optional: true,
    },
    additionalOptions: {
      type: "object",
      label: "Additional Options",
      description:
        "Additional parameters to send in the request. [See the documentation](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get) for available parameters. Values will be parsed as JSON where applicable.",
      optional: true,
    },
  },
  async run({ $ }) {
    const cloudId = await this.confluence.getCloudId({
      $,
    });
    const response = await this.confluence.getPageById({
      $,
      cloudId,
      pageId: this.pageId,
      params: {
        "body-format": this.bodyFormat,
        "get-draft": this.getDraft,
        "status": this.status,
        "version": this.version,
        ...parseObjectEntries(this.additionalOptions),
      },
    });
    $.export("$summary", `Successfully retrieved page with ID: ${this.pageId}`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Confluence	`confluence`	`app`	This component uses the Confluence app.
Page ID	`pageId`	`string`	Select a value from the drop down menu.
Body Format	`bodyFormat`	`string`	Select a value from the drop down menu:`storageatlas_doc_formatviewexport_viewanonymous_export_viewstyled_vieweditor`
Get Draft	`getDraft`	`boolean`	If true, retrieves the draft version of this page.
Status	`status`	`string[]`	Select a value from the drop down menu:`currentarchivedtrasheddeletedhistoricaldraft`
Version	`version`	`integer`	Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
Additional Options	`additionalOptions`	`object`	Additional parameters to send in the request. See the documentation for available parameters. Values will be parsed as JSON where applicable.

Authentication#

Confluence uses OAuth authentication. When you connect your Confluence account, Pipedream will open a popup window where you can sign into Confluence and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Confluence API.

Pipedream requests the following authorization scopes when you connect your account:

write:confluence-contentread:confluence-space.summarywrite:confluence-spacewrite:confluence-fileread:confluence-propswrite:confluence-propsmanage:confluence-configurationread:confluence-content.allread:confluence-content.summarysearch:confluenceread:meoffline_accessread:space:confluenceread:blogpost:confluencewrite:blogpost:confluencedelete:blogpost:confluenceread:page:confluencewrite:page:confluencedelete:page:confluence