Metadata that controls how a database property behaves.
Database properties
Each database property object contains the following keys. In addition, it must contain a key corresponding with the value of type
. The value is an object containing type-specific configuration. The type-specific configurations are described in the sections below.
Property | Type | Description | Example value |
---|---|---|---|
|
| The ID of the property, usually a short string of random letters and symbols. |
|
|
| Type that controls the behavior of the property. Possible values are: |
|
|
| The name of the property as it appears in Notion. |
Title configuration
Each database must have exactly one database property of type "title"
. This database property controls the title that appears at the top of the page when the page is opened. Title database property objects have no additional configuration within the title
property.
Text configuration
Text database property objects have no additional configuration within the rich_text
property.
Number configuration
Number database property objects contain the following configuration within the number
property:
Property | Type | Description | Example value |
---|---|---|---|
|
| How the number is displayed in Notion. Potential values include: |
|
Select configuration
Select database property objects contain the following configuration within the select
property:
Property | Type | Description | Example value |
---|---|---|---|
| array of select option objects. | Sorted list of options available for this property. |
Select options
Property | Type | Description | Example value |
---|---|---|---|
|
| Name of the option as it appears in Notion. Note: Commas (",") are not valid for select values. |
|
|
| Identifier of the option, which does not change if the name is changed. These are sometimes, but not always, UUIDs. |
|
|
| Color of the option. Possible values include: |
|
Multi-select configuration
Multi-select database property objects contain the following configuration within the multi_select
property:
Property | Type | Description | Example value |
---|---|---|---|
| array of multi-select option objects. | Settings for multi select properties. |
Multi-select options
Property | Type | Description | Example value |
---|---|---|---|
|
| Name of the option as it appears in Notion. Note: Commas (",") are not valid for select values. |
|
|
| Identifier of the option, which does not change if the name is changed. These are sometimes, but not always, UUIDs. |
|
|
| Color of the option. Possible values include: |
|
Date configuration
Date database property objects have no additional configuration within the date
property.
People configuration
People database property objects have no additional configuration within the people
property.
Files configuration
Files database property objects have no additional configuration within the files
property.
Checkbox configuration
Checkbox database property objects have no additional configuration within the checkbox
property.
URL configuration
URL database property objects have no additional configuration within the url
property.
Email configuration
Email database property objects have no additional configuration within the email
property.
Phone number configuration
Phone number database property objects have no additional configuration within the phone_number
property.
Formula configuration
Formula database property objects contain the following configuration within the formula
property:
Property | Type | Description | Example value |
---|---|---|---|
|
| Formula to evaluate for this property. You can read more about the syntax for formulas in the help center. |
|
Relation configuration
Relation database property objects contain the following configuration within the relation
property:
Property | Type | Description | Example value |
---|---|---|---|
|
| The database this relation refers to. New linked pages must belong to this database in order to be valid. |
|
|
| By default, relations are formed as two synced properties across databases: if you make a change to one property, it updates the synced property at the same time. |
|
|
| By default, relations are formed as two synced properties across databases: if you make a change to one property, it updates the synced property at the same time. |
|
Rollup configuration
Rollup database property objects contain the following configuration within the rollup
property:
Property | Type | Description | Example value |
---|---|---|---|
|
| The name of the relation property this property is responsible for rolling up. |
|
|
| The |
|
|
| The name of the property of the pages in the related database that is used as an input to |
|
|
| The |
|
|
| The function that is evaluated for every page in the relation of the rollup. |
|
Created time configuration
Created time database property objects have no additional configuration within the created_time
property.
Created by configuration
Created by database property objects have no additional configuration within the created_by
property.
Last edited time configuration
Last edited time database property objects have no additional configuration within the last_edited_time
property.
Last edited by configuration
Last edited by database property objects have no additional configuration within the last_edited_by
property.