Skip to content

Notion: Create a view query

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

← Views operations · Get started

Operation notion.create_view_query

Provider route: POST /v1/views/{view_id}/queries. 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"]["createViewQuery"]>[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.createViewQuery(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.create_view_query(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 parentThe ID of the view.
bodyModelRequired within parentExpand Create a view query — request body — body

Referenced models: Create a view query — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a view query — response body

Referenced models: Create a view query — response body

Create a view query — response body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
expires_atstringRequired within parentWhen the cached query results expire.
Format: date-time
has_morebooleanRequired within parentWhether there are more results.
idstringRequired within parentThe query ID.
Format: uuid
next_cursorJSONRequired within parentCursor for the next page of results.
next_cursor (anyOf 1)stringAlternativeFormat: uuid
next_cursor (anyOf 2)nullAlternative
objectstringRequired within parentThe object type.
Must equal: view_query
request_statusModelOptionalExpand List views — response body — request status
Set to `{ type: 'incomplete', incomplete_reason: 'query_result_limit_reached' }` when the view's underlying data source has more rows matching this query than the server-side pagination depth limit allows.
resultsarrayRequired within parentThe page results for this page.
Maximum items: 100
results[]ModelEach itemExpand Create a view query — response body — results item
total_countJSONRequired within parent
total_count (anyOf 1)numberAlternativeTotal number of results in the query.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
view_idstringRequired within parentThe view this query was executed against.
Format: uuid

Referenced models: Create a view query — response body — results item, List views — response body — request status

Create a view query — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
page_sizeintegerOptionalThe number of results to return per page. Maximum: 100
Maximum: 100
Minimum: 1
Create a view query — response body — results item
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe object ID.
Format: uuid
objectstringRequired within parentThe object type.
List views — response body — request status
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
incomplete_reasonstringOptionalWhy the result set is incomplete. Only present when `type` is `incomplete`.
Must equal: query_result_limit_reached
typestringRequired within parentWhether the result set is complete or incomplete. `incomplete` means the response does not include all rows that match the query parameters (e.g. due to a server-side pagination depth limit).
Known values: complete, incomplete

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