Skip to content

Notion: Retrieve a page property item

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

← Pages operations · Get started

Operation notion.retrieve_a_page_property

Provider route: GET /v1/pages/{page_id}/properties/{property_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"]["retrieveAPageProperty"]>[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.retrieveAPageProperty(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_property(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 containing the property.
path.property_idstringRequired within parentThe ID or name of the property to retrieve.
queryobjectOptionalAdditional keys: not allowed
query.start_cursorstringOptional
query.page_sizeintegerOptional

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 Retrieve a page property item — response body — value
$ (anyOf 2)ModelAlternativeExpand Retrieve a page property item — response body — Property Item

Referenced models: Retrieve a page property item — response body — value, Retrieve a page property item — response body — Property Item

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

Retrieve a page property item — response body — value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Number
$ (anyOf 2)ModelAlternativeExpand Retrieve a page property item — response body — value Url
$ (anyOf 3)ModelAlternativeExpand Retrieve a page property item — response body — value Select
$ (anyOf 4)ModelAlternativeExpand Retrieve a page property item — response body — value Multi Select
$ (anyOf 5)ModelAlternativeExpand Retrieve a page property item — response body — value Status
$ (anyOf 6)ModelAlternativeExpand Retrieve a page property item — response body — value Date
$ (anyOf 7)ModelAlternativeExpand Retrieve a page property item — response body — value Email
$ (anyOf 8)ModelAlternativeExpand Retrieve a page property item — response body — value Phone Number
$ (anyOf 9)ModelAlternativeExpand Retrieve a page property item — response body — value Checkbox
$ (anyOf 10)ModelAlternativeExpand Retrieve a page property item — response body — value Files
$ (anyOf 11)ModelAlternativeExpand Retrieve a page property item — response body — value Created By
$ (anyOf 12)ModelAlternativeExpand Retrieve a page property item — response body — value Created Time
$ (anyOf 13)ModelAlternativeExpand Retrieve a page property item — response body — value Last Edited By
$ (anyOf 14)ModelAlternativeExpand Retrieve a page property item — response body — value Last Edited Time
$ (anyOf 15)ModelAlternativeExpand Retrieve a page property item — response body — value Formula
$ (anyOf 16)ModelAlternativeExpand Retrieve a page property item — response body — value Button
$ (anyOf 17)ModelAlternativeExpand Retrieve a page property item — response body — value Unique Id
$ (anyOf 18)ModelAlternativeExpand Retrieve a page property item — response body — value Verification
$ (anyOf 19)ModelAlternativeExpand Retrieve a page property item — response body — value Place
$ (anyOf 20)ModelAlternativeExpand Retrieve a page property item — response body — value Title
$ (anyOf 21)ModelAlternativeExpand Retrieve a page property item — response body — value Rich Text
$ (anyOf 22)ModelAlternativeExpand Retrieve a page property item — response body — value People
$ (anyOf 23)ModelAlternativeExpand Retrieve a page property item — response body — value Relation
$ (anyOf 24)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup

Referenced models: Retrieve a page property item — response body — value Button, Retrieve a page property item — response body — value Checkbox, Retrieve a page property item — response body — value Created By, Retrieve a page property item — response body — value Created Time, Retrieve a page property item — response body — value Date, Retrieve a page property item — response body — value Email, Retrieve a page property item — response body — value Files, Retrieve a page property item — response body — value Formula, Retrieve a page property item — response body — value Last Edited By, Retrieve a page property item — response body — value Last Edited Time, Retrieve a page property item — response body — value Multi Select, Retrieve a page property item — response body — value Number, Retrieve a page property item — response body — value People, Retrieve a page property item — response body — value Phone Number, Retrieve a page property item — response body — value Place, Retrieve a page property item — response body — value Relation, Retrieve a page property item — response body — value Rich Text, Retrieve a page property item — response body — value Rollup, Retrieve a page property item — response body — value Select, Retrieve a page property item — response body — value Status, Retrieve a page property item — response body — value Title, Retrieve a page property item — response body — value Unique Id, Retrieve a page property item — response body — value Url, Retrieve a page property item — response body — value Verification

Retrieve a page property item — response body — value Button
FieldTypePresenceDescription and constraints
$objectRoot
buttonModelRequired within parentExpand List views — response body — view
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: button

Referenced models: List views — response body — view

Retrieve a page property item — response body — value Checkbox
FieldTypePresenceDescription and constraints
$objectRoot
checkboxbooleanRequired within parent
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: checkbox
Retrieve a page property item — response body — value Created By
FieldTypePresenceDescription and constraints
$objectRoot
created_byJSONRequired within parent
created_by (anyOf 1)ModelAlternativeExpand Update page — response body — object page created by
created_by (anyOf 2)ModelAlternativeExpand Retrieve a user — response body
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: created_by

Referenced models: Update page — response body — object page created by, Retrieve a user — response body

Retrieve a page property item — response body — value Created Time
FieldTypePresenceDescription and constraints
$objectRoot
created_timestringRequired within parentFormat: date-time
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: created_time
Retrieve a page property item — response body — value Email
FieldTypePresenceDescription and constraints
$objectRoot
emailJSONRequired within parent
email (anyOf 1)stringAlternative
email (anyOf 2)nullAlternative
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: email

SDK function policy ID: notion.retrieve_a_page_property. Catalog operation: retrieve_a_page_property. 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.