Notion: List file uploads
Notion fileUploads.listFileUploads: arguments, response, policy and SDK examples.
← File uploads operations · Get started
Operation notion.list_file_uploads
Provider route: GET /v1/file_uploads. 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["fileUploads"]["listFileUploads"]>[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.fileUploads.listFileUploads(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.file_uploads.list_file_uploads(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.status | string | Optional | If supplied, the endpoint will return file uploads with the specified status. One of: pending, uploaded, expired, failed |
query.start_cursor | string | Optional | If supplied, this endpoint will return a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results. |
query.page_size | integer | Optional | The number of items from the full list desired in the response. Maximum: 100 Maximum: 100 Minimum: 1 |
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 |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
file_upload | Model | Required within parent | Expand List views — response body — view |
has_more | boolean | Required within parent | |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Format: uuid |
next_cursor (anyOf 2) | null | Alternative | |
object | string | Required within parent | Always `list` Must equal: list |
request_status | Model | Optional | Expand List views — response body — request status |
results | array | Required within parent | |
results[] | Model | Each item | Expand Upload a file — response body |
type | string | Required within parent | Always `file_upload` Must equal: file_upload |
Referenced models: List views — response body — view, Upload a file — response body, List views — response body — request status
Schemas
Section titled “Schemas”List views — response body — view
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
Upload a file — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
complete_url | string | Optional | |
content_length | JSON | Required within parent | |
content_length (anyOf 1) | JSON | Alternative | |
content_length (anyOf 1) (anyOf 1) | integer | Alternative | Minimum: 0 |
content_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
content_length (anyOf 2) | null | Alternative | |
content_type | JSON | Required within parent | |
content_type (anyOf 1) | string | Alternative | |
content_type (anyOf 2) | null | Alternative | |
created_by | object | Required within parent | Additional keys: allowed |
created_by.id | string | Required within parent | Format: uuid |
created_by.type | string | Required within parent | One of: `person`, `bot`, `agent` Known values: person, bot, agent |
created_time | string | Required within parent | Format: date-time |
expiry_time | JSON | Required within parent | |
expiry_time (anyOf 1) | string | Alternative | Format: date-time |
expiry_time (anyOf 2) | null | Alternative | |
file_import_result | JSON | Optional | |
file_import_result (allOf 1) | object | All variants apply | Additional keys: allowed |
file_import_result (allOf 1).imported_time | string | Required within parent | The time the file was imported into Notion. ISO 8601 format. Format: date-time |
file_import_result (allOf 2) | JSON | All variants apply | |
file_import_result (allOf 2) (anyOf 1) | object | Alternative | |
file_import_result (allOf 2) (anyOf 1).success | Model | Required within parent | Expand List views — response body — view Empty object for success type. |
file_import_result (allOf 2) (anyOf 1).type | string | Required within parent | Indicates a successful import. Must equal: success |
file_import_result (allOf 2) (anyOf 2) | object | Alternative | |
file_import_result (allOf 2) (anyOf 2).error | object | Required within parent | Details about the error that occurred during file import. Additional keys: allowed |
file_import_result (allOf 2) (anyOf 2).error.code | string | Required within parent | A short string code representing the error. |
file_import_result (allOf 2) (anyOf 2).error.message | string | Required within parent | A human-readable message describing the error. |
file_import_result (allOf 2) (anyOf 2).error.parameter | JSON | Required within parent | The parameter related to the error, if applicable. Null if not applicable. |
file_import_result (allOf 2) (anyOf 2).error.parameter (anyOf 1) | string | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.parameter (anyOf 2) | null | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.status_code | JSON | Required within parent | The HTTP status code associated with the error, if available. Null if not applicable. |
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 1) | JSON | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 1) (anyOf 1) | integer | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 2) | null | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.type | string | Required within parent | The type of error that occurred during file import. Known values: validation_error, internal_system_error, download_error, upload_error |
file_import_result (allOf 2) (anyOf 2).type | string | Required within parent | Indicates an error occurred during import. Must equal: error |
filename | JSON | Required within parent | |
filename (anyOf 1) | string | Alternative | |
filename (anyOf 2) | null | Alternative | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_time | string | Required within parent | Format: date-time |
number_of_parts | object | Optional | Additional keys: allowed |
number_of_parts.sent | JSON | Required within parent | |
number_of_parts.sent (anyOf 1) | integer | Alternative | Minimum: 0 |
number_of_parts.sent (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_of_parts.total | JSON | Required within parent | |
number_of_parts.total (anyOf 1) | integer | Alternative | Minimum: 0 |
number_of_parts.total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
object | string | Required within parent | Always `file_upload` Must equal: file_upload |
status | string | Required within parent | One of: `pending`, `uploaded`, `expired`, `failed` Known values: pending, uploaded, expired, failed |
upload_url | string | Optional |
Referenced models: List views — response body — view
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.list_file_uploads. Catalog operation: list_file_uploads. 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"}