# Get Pages — Confluence

> Retrieve a list of pages. See the documentation

- Key: `confluence-get-pages`
- Type: Action (Read-only)
- Version: 0.0.4
- App: Confluence (`confluence`) — https://pipedream.com/apps/confluence.md
- This page (HTML): https://pipedream.com/apps/confluence/actions/get-pages
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/confluence/actions/get-pages/get-pages.mjs

## Description

Retrieve a list of pages. [See the documentation](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-get)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `sort` | `string` | No | Used to sort the result by a particular field |
| `status` | `string` | No | Filter the results to pages based on their status |
| `pageTitle` | `string` | No | Filter the results to pages based on their title |
| `bodyFormat` | `string` | No | 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. |
| `subType` | `string` | No | Filter the results to pages based on their subtype |
| `cursor` | `string` | No | 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. |
| `limit` | `integer` | No | Maximum number of pages per result to return |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "confluence",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "confluence-get-pages",
  arguments: {
    sort: "Sort",
    status: "Status",
  },
})
```

**TypeScript**

```ts
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-pages",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    confluence: { authProvisionId: "apn_xxxxxxx" },
    sort: "Sort",
    status: "Status",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "confluence-get-pages",
    "configured_props": {
      "confluence": { "authProvisionId": "apn_xxxxxxx" },
      "sort": "Sort",
      "status": "Status"
    }
  }'
```

---

- App: https://pipedream.com/apps/confluence.md · All apps: https://pipedream.com/apps