List Database Properties
List Database Properties tells you how a Notion database is set up: which properties (columns) it has, the type of each one and, for select properties, which options they accept.
It is the natural step before creating or updating pages in that database, because those components need the exact property names and the format of each one.
When to use it
- You are about to create pages in a database and want to know what its columns are called.
- You want to know the options of a select property, such as the possible statuses of a task.
- An agent has to prepare the data for a new page and needs to know the database’s structure.
Configuration
You need a Notion API credential with your Notion integration’s token. See Credentials.
| Field | What it does |
|---|---|
| Credential (required) | The Notion API credential used to access your Notion workspace. |
| Database ID | The ID of the database you want to look up. |
Output
The Data output returns the database’s properties as Notion describes them: each one’s name, its type (text, number, date, select…) and its settings. If Notion rejects the request, the flow does not stop: the output carries a message that explains why.
Example
A renovation company keeps its quotes in a Notion database and wants to automate adding new ones.
- Add List Database Properties and enter the ID of the “Quotes” database in Database ID.
- Run the component and check the output: you will see, for example, the
Customerproperty of type title andStatusof type select with its options. - Use those names and types to prepare the properties in Create Page.
Good practices
- Property names are case-sensitive: copy them exactly as they appear here.
- A database’s ID appears in its Notion link.
Related components
- Create Page: create pages in the database.
- Update Page Property: change a page’s properties.
- List Pages: query the database’s pages.