Skip to content

Notion: Retrieve a database

Notion databases.retrieveDatabase: arguments, response, policy and SDK examples.

← Databases operations · Get started

Operation notion.retrieve_database

Provider route: GET /v1/databases/{database_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/notion with npm, or alter-sdk-notion with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { NotionIntegration } from "@alter-ai/notion";
async function execute(input: Parameters<NotionIntegration["databases"]["retrieveDatabase"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new NotionIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.databases.retrieveDatabase(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_notion import NotionIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = NotionIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.databases.retrieve_database(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.database_idstringRequired within parentID of a Notion database, a container for one or more data sources.

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Create a database — response body — object database — partial Database Object Response
$ (anyOf 2)ModelAlternativeExpand Create a database — response body — object database — database Object Response

Referenced models: Create a database — response body — object database — database Object Response, Create a database — response body — object database — partial Database Object Response

35 more schemas are linked from the tables above, on the schema pages.

Create a database — response body — object database — database Object Response
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
coverJSONRequired within parentThe cover of the database.
cover (anyOf 1)ModelAlternativeExpand Update page — response body — object page cover value
cover (anyOf 2)nullAlternative
created_timestringRequired within parentThe time when the database was created.
Format: date-time
data_sourcesarrayRequired within parentThe data sources of the database.
Maximum items: 100
data_sources[]ModelEach itemExpand Create a database — response body — object database data sources item
database_typeJSONRequired within parentThe type of typed database, such as `tasks`, `projects`, or `skills`, or `null` for a regular database. Create a database accepts `tasks`, `projects`, and `skills`.
database_type (anyOf 1)stringAlternativeOne of: `tasks`, `projects`, `sprints`, `docs`, `wiki`, `meetings`, `meeting_notes`, `skills`, `github_prs`
Known values: tasks, projects, sprints, docs, wiki, meetings, meeting_notes, skills, github_prs
database_type (anyOf 2)nullAlternative
descriptionarrayRequired within parentThe description of the database.
Maximum items: 100
description[]ModelEach itemExpand Retrieve a page property item — response body — value Title title
iconJSONRequired within parentThe icon of the database.
icon (anyOf 1)ModelAlternativeExpand Get agent — response body — icon value
icon (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the database.
Format: uuid
in_trashbooleanRequired within parentWhether the database is in the trash.
is_inlinebooleanRequired within parentWhether the database is inline.
is_lockedbooleanRequired within parentWhether the database is locked from editing in the Notion app UI.
last_edited_timestringRequired within parentThe time when the database was last edited.
Format: date-time
objectstringRequired within parentThe database object type name.
Must equal: database
parentModelRequired within parentExpand Create a database — response body — object database parent
The parent of the database. This is typically a page, block, or workspace, but can be another database in the case of wikis.
public_urlJSONRequired within parentThe public URL of the database if it is publicly accessible.
public_url (anyOf 1)stringAlternative
public_url (anyOf 2)nullAlternative
show_data_source_titlebooleanRequired within parentWhether the data source title is shown above the database's views, matching the Show data source title toggle in the Notion app. Full-page databases with one data source don't show this title even when this is `true`.
titlearrayRequired within parentThe title of the database.
Maximum items: 100
title[]ModelEach itemExpand Retrieve a page property item — response body — value Title title
urlstringRequired within parentThe URL of the database.

Referenced models: Create a database — response body — object database data sources item, Update page — response body — object page cover value, Get agent — response body — icon value, Create a database — response body — object database parent, Retrieve a page property item — response body — value Title title

Create a database — response body — object database — partial Database Object Response
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the database.
Format: uuid
objectstringRequired within parentThe database object type name.
Must equal: database
Create a database — response body — object database data sources item
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the data source.
Format: uuid
namestringRequired within parentThe name of the data source.
sync_metadataobjectOptionalSync identity and available health, included when retrieving a database.
Additional keys: allowed
sync_metadata.external_collection_typestringOptionalThe provider of a legacy synced data source: Jira or Salesforce. Values are case-sensitive.
Known values: Jira, Salesforce
sync_metadata.external_database_syncobjectOptionalStored identity of an external database sync.
Additional keys: allowed
sync_metadata.external_database_sync.providerstringRequired within parentThe sync provider: github (GitHub), jira (Jira), or salesforce (Salesforce).
Known values: github, jira, salesforce
sync_metadata.external_database_sync.sync_idstringRequired within parentThe stored sync ID. This is not a credential.
Format: uuid
sync_metadata.healthJSONOptionalLive collection sync health. Null means unavailable, not unhealthy. Missing timestamps are unknown.
sync_metadata.health (anyOf 1)nullAlternative
sync_metadata.health (anyOf 2)ModelAlternativeExpand Create a data source — response body — object data_source / sync_metadata / health / ok False, stage: backfilling, initializing, steady
sync_metadata.health (anyOf 3)ModelAlternativeExpand Create a data source — response body — object data_source / sync_metadata / health / ok True, stage: backfilling, initializing, steady
sync_metadata.health (anyOf 4)objectAlternativeAdditional keys: allowed
sync_metadata.health (anyOf 4).pausedbooleanRequired within parentMust equal: true
sync_metadata.owner_user_idstringOptionalNotion user who owns the sync credential, included when health is available.
Format: uuid
sync_metadata.resourcestringOptionalProvider resource synced to this data source, when available.
sync_metadata.sync_idstringOptionalThe stored sync ID when provider details are unavailable. This is not a credential.
Format: uuid
sync_metadata.sync_stateModelOptionalExpand Create a data source — response body — object data source sync metadata sync state
sync_metadata.synced_collection_keystringOptionalOpaque, developer-defined collection key for a worker sync. It is not a globally unique ID or a credential. Worker status is not included.

Referenced models: Create a data source — response body — object data_source / sync_metadata / health / ok False, stage: backfilling, initializing, steady, Create a data source — response body — object data_source / sync_metadata / health / ok True, stage: backfilling, initializing, steady, Create a data source — response body — object data source sync metadata sync state

Update page — response body — object page cover value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update page — response body — object page cover value File
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page cover value External

Referenced models: Update page — response body — object page cover value External, Update page — response body — object page cover value File

Get agent — response body — icon value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get agent — response body — icon value Emoji
$ (anyOf 2)ModelAlternativeExpand Get agent — response body — icon value File
$ (anyOf 3)ModelAlternativeExpand Get agent — response body — icon value External
$ (anyOf 4)ModelAlternativeExpand Get agent — response body — icon value Custom Emoji
$ (anyOf 5)ModelAlternativeExpand Get agent — response body — icon value Icon

Referenced models: Get agent — response body — icon value Custom Emoji, Get agent — response body — icon value Emoji, Get agent — response body — icon value External, Get agent — response body — icon value File, Get agent — response body — icon value Icon

Get agent — response body — icon value Emoji
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
emojistringRequired within parentThe emoji character used as the icon.
typestringRequired within parentType of icon. In this case, an emoji.
Must equal: emoji

SDK function policy ID: notion.retrieve_database. Catalog operation: retrieve_database. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Notion-Version": "2026-03-11"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.