Skip to content

Notion: Retrieve a page

Notion pages.retrieveAPage: arguments, response, policy and SDK examples.

← Pages operations · Get started

Operation notion.retrieve_a_page

Provider route: GET /v1/pages/{page_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["pages"]["retrieveAPage"]>[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.pages.retrieveAPage(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.pages.retrieve_a_page(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.page_idstringRequired within parentThe ID of the page to retrieve.
queryobjectOptionalAdditional keys: not allowed
query.filter_propertiesarrayOptionalProperty names or IDs to include in each page’s `properties` object. Other properties are left out. Repeat the parameter to pass more than one value, for example `filter_properties=title&filter_properties=Status`. Pages that aren’t in a data source always return only `title`.
Maximum items: 100
query.filter_properties[]stringEach item

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 Update page — response body — object page — partial Page Object Response
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page — page Object Response

Referenced models: Update page — response body — object page — page Object Response, Update page — response body — object page — partial Page Object Response

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

Update page — response body — object page — page Object Response
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
coverJSONRequired within parentPage cover image.
cover (anyOf 1)ModelAlternativeExpand Update page — response body — object page cover value
cover (anyOf 2)nullAlternative
created_byModelRequired within parentExpand Update page — response body — object page created by
User who created the page.
created_timestringRequired within parentDate and time when this page was created.
Format: date-time
iconJSONRequired within parentPage icon.
icon (anyOf 1)ModelAlternativeExpand Get agent — response body — icon value
icon (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the page.
Format: uuid
in_trashbooleanRequired within parentWhether the page is in trash.
is_archivedbooleanRequired within parentWhether the page has been archived.
is_lockedbooleanRequired within parentWhether the page is locked from editing in the Notion app UI.
last_edited_byModelRequired within parentExpand Update page — response body — object page created by
User who last edited the page.
last_edited_timestringRequired within parentDate and time when this page was last edited.
Format: date-time
objectstringRequired within parentThe page object type name.
Must equal: page
parentModelRequired within parentExpand Update page — response body — object page parent
Information about the page's parent.
propertiesobjectRequired within parentProperty values of this page.
Additional keys: see wildcard field
properties.*ModelAdditional keysExpand Update page — response body — object page properties value
public_urlJSONRequired within parentThe public URL of the Notion page, if it has been published to the web.
public_url (anyOf 1)stringAlternative
public_url (anyOf 2)nullAlternative
urlstringRequired within parentThe URL of the Notion page.

Referenced models: Update page — response body — object page cover value, Get agent — response body — icon value, Update page — response body — object page properties value, Update page — response body — object page parent, Update page — response body — object page created by

Update page — response body — object page — partial Page Object Response
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the page.
Format: uuid
objectstringRequired within parentThe page object type name.
Must equal: page
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

Update page — response body — object page properties value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update page — response body — object page properties value id
$ (allOf 2)JSONAll variants apply
$ (allOf 2) (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value value
$ (allOf 2) (anyOf 2)ModelAlternativeExpand Update page — response body — object page properties value value type rollup

Referenced models: Update page — response body — object page properties value id, Update page — response body — object page properties value value type rollup, Update page — response body — object page properties value value value

Update page — response body — object page parent
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Delete a view — response body — parent
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page parent type data source id
$ (anyOf 3)ModelAlternativeExpand Update page — response body — object page parent type page id
$ (anyOf 4)ModelAlternativeExpand Update page — response body — object page parent type block id
$ (anyOf 5)ModelAlternativeExpand Update page — response body — object page parent type agent id
$ (anyOf 6)ModelAlternativeExpand Update page — response body — object page parent type workspace, workspace True

Referenced models: Update page — response body — object page parent type agent id, Update page — response body — object page parent type block id, Update page — response body — object page parent type data source id, Delete a view — response body — parent, Update page — response body — object page parent type page id, Update page — response body — object page parent type workspace, workspace True

Update page — response body — object page created by
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentFormat: uuid
objectstringRequired within parentAlways `user`
Must equal: user
Update page — response body — object page cover value External
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
externalobjectRequired within parentThe external URL for the cover.
Additional keys: allowed
external.urlstringRequired within parentThe URL of the external file or resource.
typestringRequired within parentType of cover. In this case, an external URL.
Must equal: external
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_a_page. Catalog operation: retrieve_a_page. 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.