View as Markdown
Notion icon

Notion ACTION

Retrieve Database Schema

Get the column (property) schema of a Notion database (data source): each property's name, type, and — for select/multi_select/status columns — its allowed option values. Call this before Query Data Source, Create Page, or Update Page on a database so you use exact property names and valid option values. Provide the data source ID (use Search with filter: data_source to resolve a database name into its ID). See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Notion account once, then configure and run Retrieve Database Schema 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: "notion-retrieve-database-schema",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    notion: { authProvisionId: "apn_xxxxxxx" },
    dataSourceId: "Data Source ID",
  },
})

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.

Retrieve Database Schema inputs
Property Type Description
dataSourceId Data Source ID string
The ID of the database's data source. Use Search (filter: data_source) to resolve a database name into its ID.
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
notion-retrieve-database-schema
Version
1.1.1
App
Notion
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes