nodes/generated

Interface NotionV3NodeParameters

Source


interface NotionV3NodeParameters {
    afterBlockId?: string;
    authentication?: "apiKey" | "oAuth2";
    blockId?: { mode: "id" | "url"; value: string };
    blocksJson?: string;
    blockUi?: {
        blockValues: {
            checked?: boolean;
            richText?: boolean;
            text?: {
                text: {
                    annotationUi?: {
                        bold?: (...) | (...) | (...);
                        code?: (...) | (...) | (...);
                        color?:
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        italic?: (...) | (...) | (...);
                        strikethrough?: (...) | (...) | (...);
                        underline?: (...) | (...) | (...);
                    };
                    database?: {
                        mode: (...)
                        | (...)
                        | (...);
                        value: string;
                    };
                    date?: string;
                    dateEnd?: string;
                    dateStart?: string;
                    expression?: string;
                    isLink?: boolean;
                    mentionType?: "page"
                    | "user"
                    | "date"
                    | "database";
                    page?: string;
                    range?: boolean;
                    text?: string;
                    textLink?: string;
                    textType?: "text" | "mention" | "equation";
                    user?: string;
                }[];
            };
            textContent?: string;
            title?: string;
            type?: string;
            url?: string;
        }[];
    };
    contentType?: "json"
    | "markdown"
    | "blockUi";
    contentUpdates?: {
        updates: {
            newString?: string;
            oldString?: string;
            replaceAllMatches?: boolean;
        }[];
    };
    databaseId?: {
        mode: "id"
        | "list"
        | "url";
        value: string;
    };
    dataSourceId?: { mode: "id"
    | "list"; value: string };
    fetchNestedBlocks?: boolean;
    filterJson?: string;
    filters?: {
        conditions: {
            checkboxValue?: boolean;
            condition?:
                | "status"
                | "contains"
                | "equals"
                | "is_empty"
                | "is_not_empty"
                | "after"
                | "before"
                | "does_not_equal"
                | "does_not_contain"
                | "starts_with"
                | "ends_with"
                | "greater_than"
                | "less_than"
                | "greater_than_or_equal_to"
                | "less_than_or_equal_to"
                | "on_or_before"
                | "on_or_after"
                | "past_week"
                | "past_month"
                | "past_year"
                | "next_week"
                | "next_month"
                | "next_year"
                | "this_week";
            dateValue?: string;
            key?: string;
            numberValue?: number;
            optionValue?: string;
            peopleValue?: string;
            relationValue?: string;
            returnType?: | "string"
            | "number"
            | "date"
            | "checkbox";
            richTextValue?: string;
            rollupJson?: string;
            type?: unknown;
            verificationStatus?: "none"
            | "expired"
            | "verified";
        }[];
    };
    filterType?: "none"
    | "manual"
    | "json";
    includeTranscript?: boolean;
    limit?: number;
    markdown?: string;
    markdownUpdateType?:
        | "replace_content"
        | "update_content";
    matchType?: "anyFilter"
    | "allFilters";
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "append"
        | "search"
        | "archive"
        | "getMarkdown"
        | "updateMarkdown";
    options?: | {
        sort?: {
            sortValue: {
                direction?: "ascending"
                | "descending";
                timestamp?: "last_edited_time";
            };
        };
    }
    | { icon?: string }
    | {
        downloadFiles?: boolean;
        sort?: {
            sortValue: {
                direction?: "ascending" | "descending";
                key?: string;
                timestamp?: boolean;
                type?: unknown;
            }[];
        };
    };
    pageId?: { mode: "id"
    | "url"; value: string };
    propertiesUi?: {
        propertyValues: {
            checkboxValue?: boolean;
            date?: string;
            dateEnd?: string;
            dateStart?: string;
            emailValue?: string;
            fileUrls?: {
                fileUrl: { name?: string; url?: string }[];
            };
            ignoreIfEmpty?: boolean;
            includeTime?: boolean;
            key?: string;
            multiSelectValue?: string;
            numberValue?: number;
            peopleValue?: unknown[];
            phoneValue?: string;
            range?: boolean;
            relationValue?: string;
            selectValue?: string;
            statusValue?: string;
            textContent?: string;
            timezone?: string;
            title?: string;
            type?: unknown;
            urlValue?: string;
        }[];
    };
    resource?: | "page"
    | "user"
    | "database"
    | "block"
    | "databasePage"
    | "dataSource";
    returnAll?: boolean;
    simple?: boolean;
    simplifyOutput?: boolean;
    text?: string;
    title?: string;
    userId?: string;
}

Properties§

§readonly afterBlockId?: string

ID of the block after which to insert the new blocks. Leave empty to append at the end.

§readonly authentication?: "apiKey" | "oAuth2"

Default: "apiKey"

§readonly blockId?: { ... }

The Notion block to append blocks to Default: {"mode":"url","value":""}

§readonly blocksJson?: string

Type options: {"rows":8}

§readonly blockUi?: { ... }

Default: {} Type options: {"multipleValues":true,"sortable":true}

§readonly contentType?: "json" | "markdown" | "blockUi"

Default: "blockUi"

§readonly contentUpdates?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly databaseId?: { ... }

The Notion database to retrieve. Use Data Source operations to search, query, or create database pages. Default: {"mode":"list","value":""}

§readonly dataSourceId?: { ... }

The Notion data source to retrieve Default: {"mode":"list","value":""}

§readonly fetchNestedBlocks?: boolean
§readonly filterJson?: string

Default: "{}" Type options: {"rows":8}

§readonly filters?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly filterType?: "none" | "manual" | "json"

Default: "none"

§readonly includeTranscript?: boolean
§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

§readonly markdown?: string

Type options: {"rows":8}

§readonly markdownUpdateType?: "replace_content" | "update_content"

Default: "replace_content"

§readonly matchType?: "anyFilter" | "allFilters"

Default: "anyFilter"

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "append"
    | "search"
    | "archive"
    | "getMarkdown"
    | "updateMarkdown"

Default: "append"

§readonly options?:
    | {
        sort?: {
            sortValue: {
                direction?: "ascending"
                | "descending";
                timestamp?: "last_edited_time";
            };
        };
    }
    | { icon?: string }
    | {
        downloadFiles?: boolean;
        sort?: {
            sortValue: {
                direction?: "ascending" | "descending";
                key?: string;
                timestamp?: boolean;
                type?: unknown;
            }[];
        };
    }

Default: {}

§readonly pageId?: { ... }

Default: {"mode":"url","value":""}

§readonly propertiesUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly resource?:
    | "page"
    | "user"
    | "database"
    | "block"
    | "databasePage"
    | "dataSource"

Default: "page"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

§readonly simplifyOutput?: boolean

Default: true

§readonly text?: string

Text to search databases/data sources for

§readonly title?: string

Page title

§readonly userId?: string