interface NotionV2NodeParameters {
blockId?: { mode: "id" | "url"; value: 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;
}[];
};
databaseId?: {
mode: "id"
| "list"
| "url";
value: string;
};
fetchNestedBlocks?: boolean;
filterJson?: string;
filters?: {
conditions: {
checkboxValue?: boolean;
condition?: | "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
}[];
};
filterType?: "none"
| "manual"
| "json";
limit?: number;
matchType?: "anyFilter" | "allFilters";
operation?:
| "create"
| "get"
| "getAll"
| "update"
| "append"
| "search"
| "archive";
options?: | {
sort?: {
sortValue: {
direction?: "ascending"
| "descending";
timestamp?: "last_edited_time";
};
};
}
| { icon?: string; iconType?: "file"
| "emoji" }
| {
downloadFiles?: boolean;
filter?: {
multipleCondition: {
condition?: {
and: {
checkboxValue?: boolean;
condition?:
| "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: | "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
}[];
or: {
checkboxValue?: boolean;
condition?: | "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: | "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
}[];
};
};
singleCondition: {
checkboxValue?: boolean;
condition?: | "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
};
};
sort?: {
sortValue: {
direction?: "ascending"
| "descending";
key?: string;
timestamp?: boolean;
type?: unknown;
}[];
};
}
| {
filter?: {
filters: {
property?: "object";
value?: "page"
| "database";
};
};
sort?: {
sortValue: {
direction?: "ascending"
| "descending";
timestamp?: "last_edited_time";
};
};
};
pageId?: string
| { 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?: unknown[];
numberValue?: number;
peopleValue?: unknown[];
phoneValue?: string;
range?: boolean;
relationValue?: string;
richText?: boolean;
selectValue?: string;
statusValue?: string;
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;
timezone?: string;
title?: string;
type?: unknown;
urlValue?: string;
}[];
};
resource?: | "page"
| "user"
| "database"
| "block"
| "databasePage";
returnAll?: boolean;
simple?: boolean;
simplifyOutput?: boolean;
text?: string;
title?: string;
userId?: string;
}
Properties§
Source§readonly block Ui?: {
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;
}[];
}
readonly block Ui?: {
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;
}[];
}
Default: {} Type options: {"multipleValues":true}
Source§readonly database Id?: { mode: "id" | "list" | "url"; value: string }
readonly database Id?: { mode: "id" | "list" | "url"; value: string }
The Notion Database to get Default: {"mode":"list","value":""}
Source§readonly filters?: {
conditions: {
checkboxValue?: boolean;
condition?:
| "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
}[];
}
readonly filters?: {
conditions: {
checkboxValue?: boolean;
condition?:
| "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
}[];
}
Default: {} Type options: {"multipleValues":true}
Source§readonly limit?: number
readonly limit?: number
Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":100}
Source§readonly operation?:
| "create"
| "get"
| "getAll"
| "update"
| "append"
| "search"
| "archive"
readonly operation?:
| "create"
| "get"
| "getAll"
| "update"
| "append"
| "search"
| "archive"
Default: "append"
Source§readonly options?:
| {
sort?: {
sortValue: {
direction?: "ascending"
| "descending";
timestamp?: "last_edited_time";
};
};
}
| { icon?: string; iconType?: "file"
| "emoji" }
| {
downloadFiles?: boolean;
filter?: {
multipleCondition: {
condition?: {
and: {
checkboxValue?: boolean;
condition?:
| "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: | "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
}[];
or: {
checkboxValue?: boolean;
condition?: | "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: | "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
}[];
};
};
singleCondition: {
checkboxValue?: boolean;
condition?: | "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
};
};
sort?: {
sortValue: {
direction?: "ascending"
| "descending";
key?: string;
timestamp?: boolean;
type?: unknown;
}[];
};
}
| {
filter?: {
filters: {
property?: "object";
value?: "page"
| "database";
};
};
sort?: {
sortValue: {
direction?: "ascending"
| "descending";
timestamp?: "last_edited_time";
};
};
}
readonly options?:
| {
sort?: {
sortValue: {
direction?: "ascending"
| "descending";
timestamp?: "last_edited_time";
};
};
}
| { icon?: string; iconType?: "file"
| "emoji" }
| {
downloadFiles?: boolean;
filter?: {
multipleCondition: {
condition?: {
and: {
checkboxValue?: boolean;
condition?:
| "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: | "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
}[];
or: {
checkboxValue?: boolean;
condition?: | "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: | "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
}[];
};
};
singleCondition: {
checkboxValue?: boolean;
condition?: | "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";
createdByValue?: string;
createdTimeValue?: string;
date?: string;
dateValue?: string;
emailValue?: string;
key?: string;
lastEditedByValue?: string;
lastEditedTime?: string;
multiSelectValue?: string;
numberValue?: number;
peopleValue?: string;
phoneNumberValue?: string;
relationValue?: string;
returnType?: "number"
| "text"
| "date"
| "checkbox";
richTextValue?: string;
selectValue?: string;
statusValue?: string;
textValue?: string;
titleValue?: string;
type?: unknown;
urlValue?: string;
};
};
sort?: {
sortValue: {
direction?: "ascending"
| "descending";
key?: string;
timestamp?: boolean;
type?: unknown;
}[];
};
}
| {
filter?: {
filters: {
property?: "object";
value?: "page"
| "database";
};
};
sort?: {
sortValue: {
direction?: "ascending"
| "descending";
timestamp?: "last_edited_time";
};
};
}
Default: {}
Source§readonly page Id?: string | { mode: "id" | "url"; value: string }
readonly page Id?: string | { mode: "id" | "url"; value: string }
The Notion Database Page to update Default: {"mode":"url","value":""}
Source§readonly properties Ui?: {
propertyValues: {
checkboxValue?: boolean;
date?: string;
dateEnd?: string;
dateStart?: string;
emailValue?: string;
fileUrls?: {
fileUrl: { name?: string; url?: string }[];
};
ignoreIfEmpty?: boolean;
includeTime?: boolean;
key?: string;
multiSelectValue?: unknown[];
numberValue?: number;
peopleValue?: unknown[];
phoneValue?: string;
range?: boolean;
relationValue?: string;
richText?: boolean;
selectValue?: string;
statusValue?: string;
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;
timezone?: string;
title?: string;
type?: unknown;
urlValue?: string;
}[];
}
readonly properties Ui?: {
propertyValues: {
checkboxValue?: boolean;
date?: string;
dateEnd?: string;
dateStart?: string;
emailValue?: string;
fileUrls?: {
fileUrl: { name?: string; url?: string }[];
};
ignoreIfEmpty?: boolean;
includeTime?: boolean;
key?: string;
multiSelectValue?: unknown[];
numberValue?: number;
peopleValue?: unknown[];
phoneValue?: string;
range?: boolean;
relationValue?: string;
richText?: boolean;
selectValue?: string;
statusValue?: string;
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;
timezone?: string;
title?: string;
type?: unknown;
urlValue?: string;
}[];
}
Default: {} Type options: {"multipleValues":true}
Source§readonly simple?: boolean
readonly simple?: boolean
Whether to return a simplified version of the response instead of the raw data Default: true
The Notion Block to append blocks to Default: {"mode":"url","value":""}