Reference

Return the audio as Markdown.

Compare blocks by their content, not by their metadata like id, timestamp etc.

Insert a block or several blocks after this block.

Reload the block from the API.

Replace this block with another block or blocks.

Return the default icon of a callout block.

Return the code content of this block as Markdown.

Return the content of this column as Markdown.

Add a new column to this block of columns at the given index.

The index must be between 0 and the number of columns (inclusive). If no index is given, the new column is added at the end.

To specify the width ratio of the new column, use the width_ratios property.

Append a block or a sequence of blocks to the content of this block.

Return the content of all columns as Markdown.

Overwrite default behaviour.

Return the number of pages in this data source.

Create a page with properties according to the schema within the corresponding data source.

Delete this data source.

Retrieve all pages and return a view.

Move this data source to a different parent database.

Reassigns the data source from its current container database to database. Cached children of the old and new parent are invalidated so the hierarchy reflects the move.

Reload this data source.

If rebind_schema is True, the schema will be rebound to the current data source. Otherwise, the schema will set to the reflected schema of the current data source.

Restore this data source.

Return the reference to this data source as Markdown.

Compare Database objects.

Hash the Database object.

Add a new data source to this database.

In case a title and a schema are provided, the title overrides the schema's db_title. If no schema is given, a default single-title schema is used. Use delete_ds() to remove one again.

Delete (move to trash) this database and all of its data sources.

Remove (move to trash) a single data source from this database.

The data source's siblings and the database container itself are left untouched. To delete the whole database (and all its data sources), use delete(). Restore a removed data source with restore_ds().

Retrieve all pages of all databases as a list of views.

Reload this database from Notion, refreshing its data sources and metadata.

Restore this database from trash.

Restore a data source previously removed from this database with delete_ds().

Return the reference to this database as Markdown.

Return the LaTeX expression of the equation as Markdown.

Return the file link as Markdown.

Return the image as Markdown.

"Return the link to page block as Markdown.

Convienence constructor for the group of options.

Return the PDF as Markdown.

Delete this page.

Directly retrieve the property value from the API.

Use this method only if you want to retrieve a specific property value that might have been updated on the server side without reloading the whole page. In all other cases, use the props namespace of the page to avoid unnecessary API calls.

Reload this page.

Restore this page.

Show the content of the page, rendered in JupyterLab

Return the content of the page as HTML.

Return the content of the page as Markdown.

Update multiple properties at once.

Delete this property from the schema.

Assert that this schema is consistent with another schema.

Bind this schema to the corresponding data source for back-reference and vice versa.

If None (default) is passed, search for the data source using db_id or db_title and bind it to this schema.

Create a page using this schema with a bound data source.

Get all read-only properties of this schema.

Get all writeable properties of this schema.

Returns the property holding the title of the pages.

Check if a property exists in this schema.

Show the schema as html or as simple table.

Return a Pydantic model of this schema for validation.

This is useful for instance when writing a web API that receives data that should be validated before it is passed to Ultimate Notion. The actual values are converted to PropertyValue and thus value needs to be called to retrieve the actual Python type.

If with_ro_props is set to True, read-only properties are included in the model.

Retrieve all users of this workspace.

Close the session and release resources.

Create a new database (a container of data sources) within a page.

In API version 2025-09-03+ every data source lives inside a database container. This creates that container together with its first data source (from schema, or a default single-title schema) and returns the Database. Use db.create_ds(...) to add further data sources, and db.data_sources to list them. Pass inline=True to display the database inline on the page.

Create a new data source within a page.

In API version 2025-09-03+ a data source under a page is created via the Create Database endpoint, which creates the database container together with its initial data source. This method returns that data source. Pass inline=True to display the database inline on the page.

In case a title and a schema are provided, title overrides the schema's db_title attribute if it exists.

Create a new page in a parent page or data source with a given title.

The blocks are optional and can be used to create a page with content right away. Note that some nested blocks may not be supported by the API and must be created separately, i.e. with an append call to a given block.

Return the current active session or None.

Retrieve a single block by an object reference.

Retrieve a Notion database (a container of data sources) by uuid.

Retrieve Notion data source by uuid.

Return the current active session or create a new session.

Get or create the data source.

Get an existing page or create a new one if it doesn't exist.

Retrieve a page by uuid.

Get a user by uuid.

In case the user is not found and raise_on_unknown is False, an User object is returned with the name Unknown User, where the property is_unknown is set to True.

Import a file from a URL.

Determine if the session is closed or not.

List all uploaded files and optionally filter by status.

Confirm that the session is active and raise otherwise.

Raises SessionError if there is a problem, otherwise returns None.

Search a data source by name or return all if name is None.

Parameters:

Search a page by name. Deleted pages, i.e. in trash, are not included in the search.

Parameters:

Search a user by name.

Upload a file to Notion.

Return the integration as bot object.

Return the synced block for appending.

Return the original block.

Return the content of this synced block as Markdown.

Append a new row to the table.

Insert a new row at the given index.

Return the table as Markdown.

Return the row as Markdown.

Add a new tab with the given label and optional icon to this block at the given index.

The index must be between 0 and the number of tabs (inclusive). If no index is given, the new tab is added at the end.

The optional icon is shown alongside the label. Notion only allows an icon on a tab-label paragraph, which is exactly what a tab is, so it is always valid here (unlike a plain Paragraph.icon, which Notion rejects outside a tab).

Append content to the new tab by indexing into the block, e.g. tabs[-1].append(...).

Append a block or a sequence of blocks to the content of this block.

Return the content of all tabs as Markdown.