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.
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"]["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 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_property(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 containing the property. |
path.property_id | string | Required within parent | The ID or name of the property to retrieve. |
query | object | Optional | Additional keys: not allowed |
query.start_cursor | string | Optional | |
query.page_size | integer | Optional |
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 Retrieve a page property item — response body — value |
$ (anyOf 2) | Model | Alternative | Expand 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
Schemas
Section titled “Schemas”59 more schemas are linked from the tables above, on the schema pages.
Retrieve a page property item — response body — value
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
button | Model | Required within parent | Expand List views — response body — view |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: button |
Referenced models: List views — response body — view
Retrieve a page property item — response body — value Checkbox
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
checkbox | boolean | Required within parent | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: checkbox |
Retrieve a page property item — response body — value Created By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | JSON | Required within parent | |
created_by (anyOf 1) | Model | Alternative | Expand Update page — response body — object page created by |
created_by (anyOf 2) | Model | Alternative | Expand Retrieve a user — response body |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_time | string | Required within parent | Format: date-time |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: created_time |
Retrieve a page property item — response body — value Email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: email |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}