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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.page_id | string | Required within parent | The ID of the page to retrieve. |
query | object | Optional | Additional keys: not allowed |
query.filter_properties | array | Optional | Property 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[] | string | Each item |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Update page — response body — object page — partial Page Object Response |
$ (anyOf 2) | Model | Alternative | Expand 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
Schemas
Section titled “Schemas”81 more schemas are linked from the tables above, on the schema pages.
Update page — response body — object page — page Object Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
cover | JSON | Required within parent | Page cover image. |
cover (anyOf 1) | Model | Alternative | Expand Update page — response body — object page cover value |
cover (anyOf 2) | null | Alternative | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by User who created the page. |
created_time | string | Required within parent | Date and time when this page was created. Format: date-time |
icon | JSON | Required within parent | Page icon. |
icon (anyOf 1) | Model | Alternative | Expand Get agent — response body — icon value |
icon (anyOf 2) | null | Alternative | |
id | string | Required within parent | The ID of the page. Format: uuid |
in_trash | boolean | Required within parent | Whether the page is in trash. |
is_archived | boolean | Required within parent | Whether the page has been archived. |
is_locked | boolean | Required within parent | Whether the page is locked from editing in the Notion app UI. |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by User who last edited the page. |
last_edited_time | string | Required within parent | Date and time when this page was last edited. Format: date-time |
object | string | Required within parent | The page object type name. Must equal: page |
parent | Model | Required within parent | Expand Update page — response body — object page parent Information about the page's parent. |
properties | object | Required within parent | Property values of this page. Additional keys: see wildcard field |
properties.* | Model | Additional keys | Expand Update page — response body — object page properties value |
public_url | JSON | Required within parent | The public URL of the Notion page, if it has been published to the web. |
public_url (anyOf 1) | string | Alternative | |
public_url (anyOf 2) | null | Alternative | |
url | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of the page. Format: uuid |
object | string | Required within parent | The page object type name. Must equal: page |
Update page — response body — object page cover value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Update page — response body — object page cover value File |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Get agent — response body — icon value Emoji |
$ (anyOf 2) | Model | Alternative | Expand Get agent — response body — icon value File |
$ (anyOf 3) | Model | Alternative | Expand Get agent — response body — icon value External |
$ (anyOf 4) | Model | Alternative | Expand Get agent — response body — icon value Custom Emoji |
$ (anyOf 5) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Update page — response body — object page properties value id |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2) (anyOf 1) | Model | Alternative | Expand Update page — response body — object page properties value value value |
$ (allOf 2) (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Delete a view — response body — parent |
$ (anyOf 2) | Model | Alternative | Expand Update page — response body — object page parent type data source id |
$ (anyOf 3) | Model | Alternative | Expand Update page — response body — object page parent type page id |
$ (anyOf 4) | Model | Alternative | Expand Update page — response body — object page parent type block id |
$ (anyOf 5) | Model | Alternative | Expand Update page — response body — object page parent type agent id |
$ (anyOf 6) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | Format: uuid |
object | string | Required within parent | Always `user` Must equal: user |
Update page — response body — object page cover value External
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
external | object | Required within parent | The external URL for the cover. Additional keys: allowed |
external.url | string | Required within parent | The URL of the external file or resource. |
type | string | Required within parent | Type of cover. In this case, an external URL. Must equal: external |
Get agent — response body — icon value Emoji
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
emoji | string | Required within parent | The emoji character used as the icon. |
type | string | Required within parent | Type of icon. In this case, an emoji. Must equal: emoji |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}