Reference

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 database.

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

Delete this database.

Retrieve all pages and return a view.

Reload this database.

Restore this database.

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.

Convert the enum to a list as needed by the (Multi)Select property types.

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.

Delete this property from the schema.

Wrap the object reference for this property.

Return the schema in a given string table format.

Some table formats:

• plain: no pseudographics
• simple: Pandoc's simple table, i.e. only dashes to separate header from content
• github: GitHub flavored Markdown
• simple_grid: uses dashes & pipes to separate cells
• html: standard html markup

Find more table formats under: astanin/python-tabulate#table-format

Assert that this schema is consistent with another schema.

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

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

Create a page using this schema with a bound database.

Get the database that is bound to this schema.

Get a specific property from this schema assuming that property names are unique.

Get all properties of this schema.

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.

Determines if the schema is bound to a database.

Show the schema as html or as simple table.

Convert this schema to a dictionary of property names and corresponding types.

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 within a page.

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

Create new databases in the right order in case there a relations between them.

Create a new page in a parent page or database 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 Notion database by uuid

Return the current active session or create a new session.

Get or create the database.

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 database by name or return all if db_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.

Return the video as Markdown.