Property object

id

string

The ID of the property, usually a short string of random letters and symbols.
Some automatically generated property types have special human-readable IDs. For example, all Title properties have an ID of "title".

"fy:{"

type

string (enum)

Type that controls the behavior of the property. Possible values are: "title", "rich_text", "number", "select", "multi_select", "date", "people", "files", "checkbox", "url", "email", "phone_number", "formula", "relation", "rollup", "created_time", "created_by", "last_edited_time", "last_edited_by".

"rich_text"

name

string

The name of the property as it appears in Notion.

format

string (enum)

How the number is displayed in Notion. Potential values include: number, number_with_commas, percent, dollar, canadian_dollar, euro, pound, yen, ruble, rupee, won, yuan, real, lira, rupiah, franc, hong_kong_dollar, new_zealand_dollar, krona, norwegian_krone, mexican_peso, rand, new_taiwan_dollar, danish_krone, zloty, baht, forint, koruna, shekel, chilean_peso, philippine_peso, dirham, colombian_peso, riyal, ringgit, leu, argentine_peso, uruguayan_peso.

"percent"

options

array of select option objects.

Sorted list of options available for this property.

name

string

Name of the option as it appears in Notion.

Note: Commas (",") are not valid for select values.

"Fruit"

id

string

Identifier of the option, which does not change if the name is changed. These are sometimes, but not always, UUIDs.

"ff8e9269-9579-47f7-8f6e-83a84716863c"

color

string (enum)

Color of the option. Possible values include: default, gray, brown, orange, yellow, green, blue, purple, pink, red.

"red"

options

array of multi-select option objects.

Settings for multi select properties.

name

string

Name of the option as it appears in Notion.

Note: Commas (",") are not valid for select values.

"Fruit"

id

string

Identifier of the option, which does not change if the name is changed. These are sometimes, but not always, UUIDs.

"ff8e9269-9579-47f7-8f6e-83a84716863c"

color

string (enum)

Color of the option. Possible values include: default, gray, brown, orange, yellow, green, blue, purple, pink, red.

"red"

expression

string

Formula to evaluate for this property. You can read more about the syntax for formulas in the help center.

"if(prop(\"In stock\"), 0, prop(\"Price\"))"

database_id

string (UUID)

The database this relation refers to. New linked pages must belong to this database in order to be valid.

"668d797c-76fa-4934-9b05-ad288df2d136"

synced_property_name

string (optional)

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. synced_property_name refers to the name of the property in the related database.

"Ingredients"

synced_property_id

string (optional)

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. synced_property_id refers to the id of the property in the related database. This is usually a short string of random letters and symbols.

"fy:{"

relation_property_name

string

The name of the relation property this property is responsible for rolling up.

"Meals"

relation_property_id

string

The id of the relation property this property is responsible for rolling up.

"fy:{"

rollup_property_name

string

The name of the property of the pages in the related database that is used as an input to function.

"Name"

rollup_property_id

string

The id of the property of the pages in the related database that is used as an input to function.

"fy:{"

function

string (enum)

The function that is evaluated for every page in the relation of the rollup.
Possible values include: count_all, count_values, count_unique_values, count_empty, count_not_empty, percent_empty, percent_not_empty, sum, average, median, min, max, range, show_original

"count_unique_values"