Skip to content

Notion: Retrieve a view

Notion views.retrieveAView: arguments, response, policy and SDK examples.

← Views operations · Get started

Operation notion.retrieve_a_view

Provider route: GET /v1/views/{view_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["views"]["retrieveAView"]>[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.views.retrieveAView(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.views.retrieve_a_view(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.view_idstringRequired within parentID of a Notion view.

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 Delete a view — response body
$ (anyOf 2)ModelAlternativeExpand Retrieve a view — response body — object view

Referenced models: Retrieve a view — response body — object view, Delete a view — response body

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

Retrieve a view — response body — object view
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
configurationJSONOptionalView presentation configuration.
configuration (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view configuration value
configuration (anyOf 2)nullAlternative
created_byJSONOptionalThe user who created the view, or null if not available.
created_by (anyOf 1)ModelAlternativeExpand Update page — response body — object page created by
created_by (anyOf 2)nullAlternative
created_timestringRequired within parentThe time when the view was created.
Format: date-time
dashboard_view_idstringOptionalFor dashboard widget views, the ID of the parent dashboard view. Only present when this view is a widget inside a dashboard.
data_source_idJSONOptionalThe ID of the data source this view is scoped to, or null for dashboard views.
data_source_id (anyOf 1)stringAlternative
data_source_id (anyOf 2)nullAlternative
filterJSONOptionalThe filter applied to this view (same shape as data source query filter).
filter (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view filter value
filter (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the view.
Format: uuid
last_edited_byJSONOptionalThe user who last edited the view, or null if not available.
last_edited_by (anyOf 1)ModelAlternativeExpand Update page — response body — object page created by
last_edited_by (anyOf 2)nullAlternative
last_edited_timestringRequired within parentThe time when the view was last edited.
Format: date-time
namestringRequired within parentThe name of the view.
objectstringRequired within parentThe object type name.
Must equal: view
parentModelRequired within parentExpand Delete a view — response body — parent
The parent database of the view.
quick_filtersJSONOptionalQuick filters pinned to the view's filter bar. Keys are property IDs. Values are filter conditions (same shape as a property filter without the property field). Null when no quick filters are set.
quick_filters (anyOf 1)objectAlternativeAdditional keys: see wildcard field
quick_filters (anyOf 1).*ModelAdditional keysExpand Retrieve a view — response body — object view quick filters object value
quick_filters (anyOf 2)nullAlternative
sortsJSONOptionalThe sorts applied to this view (same shape as data source query sorts).
sorts (anyOf 1)arrayAlternativeMaximum items: 100
sorts (anyOf 1)[]ModelEach itemExpand Retrieve a view — response body — object view sorts array item
sorts (anyOf 2)nullAlternative
typestringRequired within parentThe view type.
Known values: table, board, list, calendar, timeline, gallery, form, chart, map, dashboard
urlstringRequired within parentCanonical deep link to the view in Notion.

Referenced models: Delete a view — response body — parent, Update page — response body — object page created by, Retrieve a view — response body — object view quick filters object value, Retrieve a view — response body — object view configuration value, Retrieve a view — response body — object view filter value, Retrieve a view — response body — object view sorts array item

Delete a view — response body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the view.
Format: uuid
objectstringRequired within parentThe object type name.
Must equal: view
parentModelRequired within parentExpand Delete a view — response body — parent
The parent database of the view.
typestringRequired within parentThe view type.
Known values: table, board, list, calendar, timeline, gallery, form, chart, map, dashboard

Referenced models: Delete a view — response body — parent

Delete a view — response body — parent
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
database_idstringRequired within parentThe ID of the parent database.
Format: uuid
typestringRequired within parentThe parent type.
Must equal: database_id
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
Retrieve a view — response body — object view quick filters object value
FieldTypePresenceDescription and constraints
$objectRootA property filter condition. Same shape as a property filter but without the "property" field. For example: { "select": { "equals": "High" } }. An empty object means the quick filter has no criteria yet.
Retrieve a view — response body — object view filter value
FieldTypePresenceDescription and constraints
$JSONRootFilter for the view. Can be a property filter (filter by property value), timestamp filter (filter by created_time or last_edited_time), or compound filter (combine filters with and/or logic). Compound filters support up to 2 levels of nesting.
$ (anyOf 1)objectAlternativeA filter condition on a specific property. The property field specifies which property to filter, and an additional field specifies the filter type and condition (e.g., title, rich_text, number, checkbox, select, multi_select, date, people, files, relation, formula, rollup, etc.).
Additional keys: allowed
$ (anyOf 1).propertystringRequired within parentThe name or ID of the property to filter on.
$ (anyOf 2)objectAlternativeA filter condition on a timestamp (created_time or last_edited_time). The timestamp field specifies which timestamp, and a matching field contains the date filter condition.
Additional keys: allowed
$ (anyOf 2).timestampstringRequired within parentThe timestamp to filter on.
Known values: created_time, last_edited_time
$ (anyOf 3)objectAlternativeA compound filter that combines multiple filters with AND or OR logic. Supports up to 2 levels of nesting.
$ (anyOf 3).andarrayOptionalFilters combined with AND logic.
$ (anyOf 3).and[]JSONEach itemA filter that can be a property filter, timestamp filter, or nested compound filter.
$ (anyOf 3).and[] (anyOf 1)objectAlternativeA filter condition on a specific property. The property field specifies which property to filter, and an additional field specifies the filter type and condition (e.g., title, rich_text, number, checkbox, select, multi_select, date, people, files, relation, formula, rollup, etc.).
Additional keys: allowed
$ (anyOf 3).and[] (anyOf 1).propertystringRequired within parentThe name or ID of the property to filter on.
$ (anyOf 3).and[] (anyOf 2)objectAlternativeA filter condition on a timestamp (created_time or last_edited_time). The timestamp field specifies which timestamp, and a matching field contains the date filter condition.
Additional keys: allowed
$ (anyOf 3).and[] (anyOf 2).timestampstringRequired within parentThe timestamp to filter on.
Known values: created_time, last_edited_time
$ (anyOf 3).and[] (anyOf 3)ModelAlternativeExpand Retrieve a view — response body — object view filter value and, or or item and, or
$ (anyOf 3).orarrayOptionalFilters combined with OR logic.
$ (anyOf 3).or[]JSONEach itemA filter that can be a property filter, timestamp filter, or nested compound filter.
$ (anyOf 3).or[] (anyOf 1)objectAlternativeA filter condition on a specific property. The property field specifies which property to filter, and an additional field specifies the filter type and condition (e.g., title, rich_text, number, checkbox, select, multi_select, date, people, files, relation, formula, rollup, etc.).
Additional keys: allowed
$ (anyOf 3).or[] (anyOf 1).propertystringRequired within parentThe name or ID of the property to filter on.
$ (anyOf 3).or[] (anyOf 2)objectAlternativeA filter condition on a timestamp (created_time or last_edited_time). The timestamp field specifies which timestamp, and a matching field contains the date filter condition.
Additional keys: allowed
$ (anyOf 3).or[] (anyOf 2).timestampstringRequired within parentThe timestamp to filter on.
Known values: created_time, last_edited_time
$ (anyOf 3).or[] (anyOf 3)ModelAlternativeExpand Retrieve a view — response body — object view filter value and, or or item and, or

Referenced models: Retrieve a view — response body — object view filter value and, or or item and, or

Retrieve a view — response body — object view / sorts / array / item / direction: ascending, descending
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
directionstringRequired within parentSort direction.
Known values: ascending, descending
propertystringRequired within parentThe name or ID of the property to sort by.

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