Objects

Model tree

DataSourceCreateBody

The body of a create-data-source request.

Field	Type	Description
`parent` *	Parent	The database this data source becomes a table of, as `{"type": "database_id", "database_id": ...}`.
`properties` *	map of PropertyConfiguration	The columns, keyed by name. Exactly one must be the `title` column — every data source has one and it cannot be removed.
`title`	RichText[]	The title of the data source, as it appears in Notion. max 100 items
`icon`	Icon	The data source’s icon.

DataSourceUpdateBody

The body of an update-data-source request.

Field	Type	Description
`parent`	DataSourceParent	A different database to move this data source into. Left where it is when absent.
`title`	RichText[]	The title of the data source, as it appears in Notion. max 100 items
`icon`	Icon	The data source’s icon. Null removes it.
`properties`	map of PropertyUpdate	The columns to change, keyed by current name or ID. A name not already on the data source adds a column; `{"name": "..."}` renames one; mapping a key to null removes it.
`inTrash`	`boolean`	Whether the data source is in the trash.

DataSourceParent

The database a data source belongs to.

Field	Type	Description
`type`	`string`	Always `database_id`.
`databaseId` *	`string`	The ID of the parent database, with or without dashes.

PropertyUpdate

A change to one column of an existing data source.

Field	Type	Description
`type`	`string`	The type of the column. Returned on a read; on a write Notion infers it from whichever configuration field below is set.
`description`	`string`	The description of the property. max length 280
`title`	EmptyConfig	The title column. Every data source has exactly one, and it cannot be deleted. Send an empty object.
`richText`	EmptyConfig	A text column. Send an empty object.
`number`	NumberConfig	A number column.
`select`	SelectConfig	A single-choice column.
`multiSelect`	SelectConfig	A multiple-choice column.
`status`	StatusConfig	A status column, whose options belong to three groups.
`date`	EmptyConfig	A date column. Send an empty object.
`people`	EmptyConfig	A people column. Send an empty object.
`files`	EmptyConfig	A files column. Send an empty object.
`checkbox`	EmptyConfig	A checkbox column. Send an empty object.
`url`	EmptyConfig	A URL column. Send an empty object.
`email`	EmptyConfig	An email column. Send an empty object.
`phoneNumber`	EmptyConfig	A phone number column. Send an empty object.
`formula`	FormulaConfig	A column computed from the page’s other properties.
`relation`	RelationConfig	A column of links to pages in another data source.
`rollup`	RollupConfig	A column that gathers values through a relation.
`createdTime`	EmptyConfig	When the page was created. Send an empty object.
`createdBy`	EmptyConfig	Who created the page. Send an empty object.
`lastEditedTime`	EmptyConfig	When the page was last edited. Send an empty object.
`lastEditedBy`	EmptyConfig	Who last edited the page. Send an empty object.
`lastVisitedTime`	EmptyConfig	When the page was last visited. Send an empty object.
`uniqueId`	UniqueIdConfig	An ID Notion increments for each new page.
`verification`	EmptyConfig	A wiki page’s verification status. Send an empty object.
`button`	EmptyConfig	A button column. Send an empty object.
`location`	EmptyConfig	A location column. Send an empty object.
`place`	EmptyConfig	A place column. Send an empty object.
`name`	`string`	The new name of the property.

DataSourceQueryBody

The body of a query request.

Field	Type	Description
`filter`	Filter	Which rows to return. Omit to return all of them.
`sorts`	Sort[]	How to order the rows. Earlier entries in the list take precedence.
`startCursor`	`string`	A `next_cursor` from a previous response.
`pageSize`	`integer`	How many rows to return. Maximum 100. ≥ 1; ≤ 100
`isArchived`	`boolean`	Whether to return archived pages instead of live ones. Live pages when absent.
`resultType`	`"page" \| "data_source"`	Restrict the results to pages or to nested data sources. Only a wiki database has data source children; absent, both come back.

Filter

Which rows a query returns.

Field	Type	Description
`and`	Filter[]	Filters that must all match. Nests at most two levels deep. max 100 items
`or`	Filter[]	Filters of which at least one must match. Nests at most two levels deep. max 100 items
`property`	`string`	The name or ID of the property to filter on. Required for a property filter.
`timestamp`	`"created_time" \| "last_edited_time"`	Filter on when the page was created or last edited rather than on one of its properties.
`type`	`string`	The type of the property being filtered on.
`title`	TextCondition	A condition on the title.
`richText`	TextCondition	A condition on a text property.
`url`	TextCondition	A condition on a URL property.
`email`	TextCondition	A condition on an email property.
`phoneNumber`	TextCondition	A condition on a phone number property.
`number`	NumberCondition	A condition on a number property.
`uniqueId`	NumberCondition	A condition on the auto-incrementing ID.
`checkbox`	CheckboxCondition	A condition on a checkbox property.
`select`	SelectCondition	A condition on a select property.
`status`	SelectCondition	A condition on a status property.
`multiSelect`	MultiSelectCondition	A condition on a multi-select property.
`date`	DateCondition	A condition on a date property.
`createdTime`	DateCondition	A condition on when the page was created.
`lastEditedTime`	DateCondition	A condition on when the page was last edited.
`people`	PeopleCondition	A condition on a people property.
`createdBy`	PeopleCondition	A condition on who created the page.
`lastEditedBy`	PeopleCondition	A condition on who last edited the page.
`files`	ExistenceCondition	A condition on whether a files property has any file.
`relation`	RelationCondition	A condition on a relation property.
`formula`	FormulaCondition	A condition on a formula’s result.
`rollup`	RollupCondition	A condition on a rollup’s value.
`verification`	VerificationCondition	A condition on a wiki page’s verification status.

TextCondition

Conditions on a text-valued property.

Field	Type	Description
`isEmpty`	`boolean`	Whether the property value is empty. Only `true` is accepted.
`isNotEmpty`	`boolean`	Whether the property value is not empty. Only `true` is accepted.
`equals`	`string`	The exact string to match.
`doesNotEqual`	`string`	The exact string to exclude.
`contains`	`string`	A substring the value must contain.
`doesNotContain`	`string`	A substring the value must not contain.
`startsWith`	`string`	A prefix the value must have.
`endsWith`	`string`	A suffix the value must have.

NumberCondition

Conditions on a number-valued property.

Field	Type	Description
`isEmpty`	`boolean`	Whether the property value is empty. Only `true` is accepted.
`isNotEmpty`	`boolean`	Whether the property value is not empty. Only `true` is accepted.
`equals`	`number`	The number to match.
`doesNotEqual`	`number`	The number to exclude.
`greaterThan`	`number`	An exclusive lower bound.
`lessThan`	`number`	An exclusive upper bound.
`greaterThanOrEqualTo`	`number`	An inclusive lower bound.
`lessThanOrEqualTo`	`number`	An inclusive upper bound.

CheckboxCondition

Conditions on a checkbox property.

Field	Type	Description
`equals`	`boolean`	Whether the checkbox is checked.
`doesNotEqual`	`boolean`	Whether the checkbox is not in this state.

SelectCondition

Conditions on a select or status property.

Field	Type	Description
`isEmpty`	`boolean`	Whether the property value is empty. Only `true` is accepted.
`isNotEmpty`	`boolean`	Whether the property value is not empty. Only `true` is accepted.
`equals`	`string` \| `string`[]	The option name to match. A list matches any of several options.
`doesNotEqual`	`string` \| `string`[]	The option name to exclude. A list excludes several.

MultiSelectCondition

Conditions on a multi-select property.

Field	Type	Description
`isEmpty`	`boolean`	Whether the property value is empty. Only `true` is accepted.
`isNotEmpty`	`boolean`	Whether the property value is not empty. Only `true` is accepted.
`contains`	`string` \| `string`[]	An option the value must include.
`doesNotContain`	`string` \| `string`[]	An option the value must not include.

DateCondition

Conditions on a date-valued property.

Field	Type	Description
`isEmpty`	`boolean`	Whether the property value is empty. Only `true` is accepted.
`isNotEmpty`	`boolean`	Whether the property value is not empty. Only `true` is accepted.
`equals`	`string`	An ISO 8601 date to match. Also accepts one of Notion’s relative values: `today`, `tomorrow`, `yesterday`, `one_week_ago`, `one_week_from_now`, `one_month_ago`, `one_month_from_now`.
`before`	`string`	An ISO 8601 date the value must precede. Also accepts one of Notion’s relative values: `today`, `tomorrow`, `yesterday`, `one_week_ago`, `one_week_from_now`, `one_month_ago`, `one_month_from_now`.
`after`	`string`	An ISO 8601 date the value must follow. Also accepts one of Notion’s relative values: `today`, `tomorrow`, `yesterday`, `one_week_ago`, `one_week_from_now`, `one_month_ago`, `one_month_from_now`.
`onOrBefore`	`string`	An ISO 8601 date the value must not follow. Also accepts one of Notion’s relative values: `today`, `tomorrow`, `yesterday`, `one_week_ago`, `one_week_from_now`, `one_month_ago`, `one_month_from_now`.
`onOrAfter`	`string`	An ISO 8601 date the value must not precede. Also accepts one of Notion’s relative values: `today`, `tomorrow`, `yesterday`, `one_week_ago`, `one_week_from_now`, `one_month_ago`, `one_month_from_now`.
`thisWeek`	EmptyCondition	Whether the date is in the current week. Send an empty object.
`pastWeek`	EmptyCondition	Whether the date is in the past week. Send an empty object.
`pastMonth`	EmptyCondition	Whether the date is in the past month. Send an empty object.
`pastYear`	EmptyCondition	Whether the date is in the past year. Send an empty object.
`nextWeek`	EmptyCondition	Whether the date is in the next week. Send an empty object.
`nextMonth`	EmptyCondition	Whether the date is in the next month. Send an empty object.
`nextYear`	EmptyCondition	Whether the date is in the next year. Send an empty object.

EmptyCondition

A condition that needs no argument, such as past_week. This object has no settable fields.

PeopleCondition

Conditions on a people property.

Field	Type	Description
`isEmpty`	`boolean`	Whether the property value is empty. Only `true` is accepted.
`isNotEmpty`	`boolean`	Whether the property value is not empty. Only `true` is accepted.
`contains`	`string`	The ID of a user the value must include. The literal `me` stands for the user the token acts as.
`doesNotContain`	`string`	The ID of a user the value must not include. `me` is accepted here too.

ExistenceCondition

Whether a property has any value at all.

Field	Type	Description
`isEmpty`	`boolean`	Whether the property value is empty. Only `true` is accepted.
`isNotEmpty`	`boolean`	Whether the property value is not empty. Only `true` is accepted.

RelationCondition

Conditions on a relation property.

Field	Type	Description
`isEmpty`	`boolean`	Whether the property value is empty. Only `true` is accepted.
`isNotEmpty`	`boolean`	Whether the property value is not empty. Only `true` is accepted.
`contains`	`string`	The ID of a page the relation must include.
`doesNotContain`	`string`	The ID of a page the relation must not include.

FormulaCondition

Conditions on a formula property, applied to the formula’s result.

Field	Type	Description
`string`	TextCondition	Applied when the formula returns a string.
`checkbox`	CheckboxCondition	Applied when the formula returns a boolean.
`number`	NumberCondition	Applied when the formula returns a number.
`date`	DateCondition	Applied when the formula returns a date.

RollupCondition

Conditions on a rollup property.

Field	Type	Description
`any`	RollupSubCondition	Matches when at least one gathered value matches.
`none`	RollupSubCondition	Matches when no gathered value matches.
`every`	RollupSubCondition	Matches when every gathered value matches.
`date`	DateCondition	Applied when the rollup aggregates to a date.
`number`	NumberCondition	Applied when the rollup aggregates to a number.

RollupSubCondition

A condition applied to each value a rollup gathers.

Field	Type	Description
`richText`	TextCondition	A text condition.
`number`	NumberCondition	A number condition.
`checkbox`	CheckboxCondition	A checkbox condition.
`select`	SelectCondition	A select condition.
`multiSelect`	MultiSelectCondition	A multi-select condition.
`status`	SelectCondition	A status condition.
`relation`	RelationCondition	A relation condition.
`date`	DateCondition	A date condition.
`people`	PeopleCondition	A people condition.
`files`	ExistenceCondition	A files condition.

VerificationCondition

Conditions on a verification property, for pages in a wiki database.

Field	Type	Description
`status` *	`"verified" \| "expired" \| "none"`	The verification status to match.

Sort

How to order the rows a query returns.

Field	Type	Description
`property`	`string`	The name or ID of the property to sort by.
`timestamp`	`"created_time" \| "last_edited_time"`	Sort by when the page was created or last edited.
`direction` *	`"ascending" \| "descending"`	Whether to sort ascending or descending.

OAuth packs

API-key packs

Model tree

DataSourceCreateBody

DataSourceUpdateBody

DataSourceParent

PropertyUpdate

DataSourceQueryBody

Filter

TextCondition

NumberCondition

CheckboxCondition

SelectCondition

MultiSelectCondition

DateCondition

EmptyCondition

PeopleCondition

ExistenceCondition

RelationCondition

FormulaCondition

RollupCondition

RollupSubCondition

VerificationCondition

Sort

​Model tree

​DataSourceCreateBody

​DataSourceUpdateBody

​DataSourceParent

​PropertyUpdate

​DataSourceQueryBody

​Filter

​TextCondition

​NumberCondition

​CheckboxCondition

​SelectCondition

​MultiSelectCondition

​DateCondition

​EmptyCondition

​PeopleCondition

​ExistenceCondition

​RelationCondition

​FormulaCondition

​RollupCondition

​RollupSubCondition

​VerificationCondition

​Sort

Model tree

DataSourceCreateBody

DataSourceUpdateBody

DataSourceParent

PropertyUpdate

DataSourceQueryBody

Filter

TextCondition

NumberCondition

CheckboxCondition

SelectCondition

MultiSelectCondition

DateCondition

EmptyCondition

PeopleCondition

ExistenceCondition

RelationCondition

FormulaCondition

RollupCondition

RollupSubCondition

VerificationCondition

Sort