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.
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["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 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.views.create_view_query(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.view_id | string | Required within parent | The ID of the view. |
body | Model | Required within parent | Expand Create a view query — request body — body |
Referenced models: Create a view query — request body — body
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 |
|---|---|---|---|
$ | Model | Root | Expand Create a view query — response body |
Referenced models: Create a view query — response body
Schemas
Section titled “Schemas”Create a view query — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
expires_at | string | Required within parent | When the cached query results expire. Format: date-time |
has_more | boolean | Required within parent | Whether there are more results. |
id | string | Required within parent | The query ID. Format: uuid |
next_cursor | JSON | Required within parent | Cursor for the next page of results. |
next_cursor (anyOf 1) | string | Alternative | Format: uuid |
next_cursor (anyOf 2) | null | Alternative | |
object | string | Required within parent | The object type. Must equal: view_query |
request_status | Model | Optional | Expand 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. |
results | array | Required within parent | The page results for this page. Maximum items: 100 |
results[] | Model | Each item | Expand Create a view query — response body — results item |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | number | Alternative | Total number of results in the query. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
view_id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
page_size | integer | Optional | The number of results to return per page. Maximum: 100 Maximum: 100 Minimum: 1 |
Create a view query — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The object ID. Format: uuid |
object | string | Required within parent | The object type. |
List views — response body — request status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
incomplete_reason | string | Optional | Why the result set is incomplete. Only present when `type` is `incomplete`. Must equal: query_result_limit_reached |
type | string | Required within parent | Whether 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}