View as Markdown
Roam Research icon

Roam Research ACTION

Get Page Or Block Data

Get the data for a page or block in Roam Research (access only to non ecrypted graphs). See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Roam Research account once, then configure and run Get Page Or Block Data 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: "roamresearch-get-page-or-block-data",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    roamresearch: { authProvisionId: "apn_xxxxxxx" },
    resourceType: "Resource Type",
    pageOrBlock: "Page Title Or Block UID",
  },
})

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 Or Block Data inputs
Property Type Description
resourceType Resource Type string
The type of resource to get data for.
Required
pageOrBlock Page Title Or Block UID string
The page title of the block uid to get data for. Page title example: My Page and Block UID example: ideWWvTgI.
Required

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
roamresearch-get-page-or-block-data
Version
0.0.3
App
Roam Research
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes