Skip to content

Notion: Data sources schemas

98 Notion schemas with complete fields and constraints.

← Data sources operations · All schemas

Create a data source — request body — body parent

FieldTypePresenceDescription and constraints
$objectRoot
database_idstringRequired within parentThe ID of the parent database (with or without dashes), for example, 195de9221179449fab8075a27c979105
typestringOptionalAlways `database_id`
Must equal: database_id

Create a data source — request body — body properties value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Create a data source — request body — body properties value description
$ (allOf 2)JSONAll variants apply
$ (allOf 2) (oneOf 1)ModelAlternativeExpand Create a data source — request body — body properties value value Number
$ (allOf 2) (oneOf 2)ModelAlternativeExpand Create a data source — request body — body properties value value Formula
$ (allOf 2) (oneOf 3)ModelAlternativeExpand Create a data source — request body — body properties value value Select
$ (allOf 2) (oneOf 4)ModelAlternativeExpand Create a data source — request body — body properties value value Multi Select
$ (allOf 2) (oneOf 5)ModelAlternativeExpand Create a data source — request body — body properties value value Status
$ (allOf 2) (oneOf 6)ModelAlternativeExpand Create a data source — request body — body properties value value Relation
$ (allOf 2) (oneOf 7)ModelAlternativeExpand Create a data source — request body — body properties value value Rollup
$ (allOf 2) (oneOf 8)ModelAlternativeExpand Create a data source — request body — body properties value value Unique Id
$ (allOf 2) (oneOf 9)ModelAlternativeExpand Create a data source — request body — body properties value value Title
$ (allOf 2) (oneOf 10)ModelAlternativeExpand Create a data source — request body — body properties value value Rich Text
$ (allOf 2) (oneOf 11)ModelAlternativeExpand Create a data source — request body — body properties value value Url
$ (allOf 2) (oneOf 12)ModelAlternativeExpand Create a data source — request body — body properties value value People
$ (allOf 2) (oneOf 13)ModelAlternativeExpand Create a data source — request body — body properties value value Files
$ (allOf 2) (oneOf 14)ModelAlternativeExpand Create a data source — request body — body properties value value Email
$ (allOf 2) (oneOf 15)ModelAlternativeExpand Create a data source — request body — body properties value value Phone Number
$ (allOf 2) (oneOf 16)ModelAlternativeExpand Create a data source — request body — body properties value value Date
$ (allOf 2) (oneOf 17)ModelAlternativeExpand Create a data source — request body — body properties value value Checkbox
$ (allOf 2) (oneOf 18)ModelAlternativeExpand Create a data source — request body — body properties value value Created By
$ (allOf 2) (oneOf 19)ModelAlternativeExpand Create a data source — request body — body properties value value Created Time
$ (allOf 2) (oneOf 20)ModelAlternativeExpand Create a data source — request body — body properties value value Last Edited By
$ (allOf 2) (oneOf 21)ModelAlternativeExpand Create a data source — request body — body properties value value Last Edited Time
$ (allOf 2) (oneOf 22)ModelAlternativeExpand Create a data source — request body — body properties value value Button
$ (allOf 2) (oneOf 23)ModelAlternativeExpand Create a data source — request body — body properties value value Location
$ (allOf 2) (oneOf 24)ModelAlternativeExpand Create a data source — request body — body properties value value Verification
$ (allOf 2) (oneOf 25)ModelAlternativeExpand Create a data source — request body — body properties value value Last Visited Time
$ (allOf 2) (oneOf 26)ModelAlternativeExpand Create a data source — request body — body properties value value Place

Referenced models: Create a data source — request body — body properties value value Button, Create a data source — request body — body properties value value Checkbox, Create a data source — request body — body properties value value Created By, Create a data source — request body — body properties value value Created Time, Create a data source — request body — body properties value value Date, Create a data source — request body — body properties value value Email, Create a data source — request body — body properties value value Files, Create a data source — request body — body properties value value Formula, Create a data source — request body — body properties value value Last Edited By, Create a data source — request body — body properties value value Last Edited Time, Create a data source — request body — body properties value value Last Visited Time, Create a data source — request body — body properties value value Location, Create a data source — request body — body properties value value Multi Select, Create a data source — request body — body properties value value Number, Create a data source — request body — body properties value value People, Create a data source — request body — body properties value value Phone Number, Create a data source — request body — body properties value value Place, Create a data source — request body — body properties value description, Create a data source — request body — body properties value value Relation, Create a data source — request body — body properties value value Rich Text, Create a data source — request body — body properties value value Rollup, Create a data source — request body — body properties value value Select, Create a data source — request body — body properties value value Status, Create a data source — request body — body properties value value Title, Create a data source — request body — body properties value value Unique Id, Create a data source — request body — body properties value value Url, Create a data source — request body — body properties value value Verification

Create a data source — request body — body properties value description

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptionalThe description of the property.
description (oneOf 1)stringAlternativeMaximum length: 280
Minimum length: 1
description (oneOf 2)nullAlternative

Create a data source — request body — body properties value value Button

FieldTypePresenceDescription and constraints
$objectRoot
buttonModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `button`
Must equal: button

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Checkbox

FieldTypePresenceDescription and constraints
$objectRoot
checkboxModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `checkbox`
Must equal: checkbox

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Created By

FieldTypePresenceDescription and constraints
$objectRoot
created_byModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `created_by`
Must equal: created_by

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Created Time

FieldTypePresenceDescription and constraints
$objectRoot
created_timeModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `created_time`
Must equal: created_time

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Date

FieldTypePresenceDescription and constraints
$objectRoot
dateModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `date`
Must equal: date

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Email

FieldTypePresenceDescription and constraints
$objectRoot
emailModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `email`
Must equal: email

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Files

FieldTypePresenceDescription and constraints
$objectRoot
filesModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `files`
Must equal: files

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Formula

FieldTypePresenceDescription and constraints
$objectRoot
formulaobjectRequired within parent
formula.expressionstringOptional
typestringOptionalAlways `formula`
Must equal: formula

Create a data source — request body — body properties value value Last Edited By

FieldTypePresenceDescription and constraints
$objectRoot
last_edited_byModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `last_edited_by`
Must equal: last_edited_by

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Last Edited Time

FieldTypePresenceDescription and constraints
$objectRoot
last_edited_timeModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `last_edited_time`
Must equal: last_edited_time

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Last Visited Time

FieldTypePresenceDescription and constraints
$objectRoot
last_visited_timeModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `last_visited_time`
Must equal: last_visited_time

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Location

FieldTypePresenceDescription and constraints
$objectRoot
locationModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `location`
Must equal: location

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Multi Select

FieldTypePresenceDescription and constraints
$objectRoot
multi_selectobjectRequired within parent
multi_select.optionsarrayOptionalMaximum items: 100
multi_select.options[]objectEach item
multi_select.options[].colorstringOptionalOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
One of: default, gray, brown, orange, yellow, green, blue, purple, pink, red
multi_select.options[].descriptionJSONOptional
multi_select.options[].description (oneOf 1)stringAlternative
multi_select.options[].description (oneOf 2)nullAlternative
multi_select.options[].namestringRequired within parent
typestringOptionalAlways `multi_select`
Must equal: multi_select

Create a data source — request body — body properties value value Number

FieldTypePresenceDescription and constraints
$objectRoot
numberobjectRequired within parent
number.formatstringOptional
typestringOptionalAlways `number`
Must equal: number

Create a data source — request body — body properties value value People

FieldTypePresenceDescription and constraints
$objectRoot
peopleModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `people`
Must equal: people

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Phone Number

FieldTypePresenceDescription and constraints
$objectRoot
phone_numberModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `phone_number`
Must equal: phone_number

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Place

FieldTypePresenceDescription and constraints
$objectRoot
placeModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `place`
Must equal: place

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Relation

FieldTypePresenceDescription and constraints
$objectRoot
relationJSONRequired within parent
relation (allOf 1)objectAll variants apply
relation (allOf 1).data_source_idstringRequired within parent
relation (allOf 2)JSONAll variants apply
relation (allOf 2) (oneOf 1)objectAlternative
relation (allOf 2) (oneOf 1).single_propertyModelRequired within parentExpand Update a block — request body — body value type tab tab
relation (allOf 2) (oneOf 1).typestringOptionalAlways `single_property`
Must equal: single_property
relation (allOf 2) (oneOf 2)objectAlternative
relation (allOf 2) (oneOf 2).dual_propertyobjectRequired within parent
relation (allOf 2) (oneOf 2).dual_property.synced_property_idstringOptional
relation (allOf 2) (oneOf 2).dual_property.synced_property_namestringOptional
relation (allOf 2) (oneOf 2).typestringOptionalAlways `dual_property`
Must equal: dual_property
typestringOptionalAlways `relation`
Must equal: relation

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Rich Text

FieldTypePresenceDescription and constraints
$objectRoot
rich_textModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `rich_text`
Must equal: rich_text

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Rollup

FieldTypePresenceDescription and constraints
$objectRoot
rollupJSONRequired within parent
rollup (allOf 1)objectAll variants apply
rollup (allOf 1).functionstringRequired within parentThe function to use for the rollup, e.g. count, count_values, percent_not_empty, max.
One of: count, count_values, empty, not_empty, unique, show_unique, percent_empty, percent_not_empty, sum, average, median, min, max, range, earliest_date, latest_date, date_range, checked, unchecked, percent_checked, percent_unchecked, count_per_group, percent_per_group, show_original
rollup (allOf 2)JSONAll variants apply
rollup (allOf 2) (oneOf 1)objectAlternative
rollup (allOf 2) (oneOf 1).relation_property_namestringRequired within parent
rollup (allOf 2) (oneOf 1).rollup_property_namestringRequired within parent
rollup (allOf 2) (oneOf 2)objectAlternative
rollup (allOf 2) (oneOf 2).relation_property_idstringRequired within parent
rollup (allOf 2) (oneOf 2).rollup_property_namestringRequired within parent
rollup (allOf 2) (oneOf 3)objectAlternative
rollup (allOf 2) (oneOf 3).relation_property_namestringRequired within parent
rollup (allOf 2) (oneOf 3).rollup_property_idstringRequired within parent
rollup (allOf 2) (oneOf 4)objectAlternative
rollup (allOf 2) (oneOf 4).relation_property_idstringRequired within parent
rollup (allOf 2) (oneOf 4).rollup_property_idstringRequired within parent
typestringOptionalAlways `rollup`
Must equal: rollup

Create a data source — request body — body properties value value Select

FieldTypePresenceDescription and constraints
$objectRoot
selectobjectRequired within parent
select.optionsarrayOptionalMaximum items: 100
select.options[]objectEach item
select.options[].colorstringOptionalOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
One of: default, gray, brown, orange, yellow, green, blue, purple, pink, red
select.options[].descriptionJSONOptional
select.options[].description (oneOf 1)stringAlternative
select.options[].description (oneOf 2)nullAlternative
select.options[].namestringRequired within parent
typestringOptionalAlways `select`
Must equal: select

Create a data source — request body — body properties value value Status

FieldTypePresenceDescription and constraints
$objectRoot
statusModelRequired within parentExpand Create a data source — request body — body properties value value Status status
typestringOptionalAlways `status`
Must equal: status

Referenced models: Create a data source — request body — body properties value value Status status

Create a data source — request body — body properties value value Status status

FieldTypePresenceDescription and constraints
$objectRoot
optionsModelOptionalExpand Create a data source — request body — body properties value value Status status options
The initial status options. If not provided, defaults are created.

Referenced models: Create a data source — request body — body properties value value Status status options

Create a data source — request body — body properties value value Status status options

FieldTypePresenceDescription and constraints
$arrayRootMaximum items: 100
$[]ModelEach itemExpand Create a data source — request body — body properties value value Status status options item

Referenced models: Create a data source — request body — body properties value value Status status options item

Create a data source — request body — body properties value value Status status options item

FieldTypePresenceDescription and constraints
$objectRoot
colorstringOptionalOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
One of: default, gray, brown, orange, yellow, green, blue, purple, pink, red
descriptionJSONOptional
description (oneOf 1)stringAlternative
description (oneOf 2)nullAlternative
groupstringOptionalOne of: `To-do`, `In progress`, `Complete`
One of: To-do, In progress, Complete
namestringRequired within parent

Create a data source — request body — body properties value value Title

FieldTypePresenceDescription and constraints
$objectRoot
titleModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringOptionalAlways `title`
Must equal: title

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Unique Id

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalAlways `unique_id`
Must equal: unique_id
unique_idobjectRequired within parent
unique_id.prefixJSONOptional
unique_id.prefix (oneOf 1)stringAlternative
unique_id.prefix (oneOf 2)nullAlternative

Create a data source — request body — body properties value value Url

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalAlways `url`
Must equal: url
urlModelRequired within parentExpand Update a block — request body — body value type tab tab

Referenced models: Update a block — request body — body value type tab tab

Create a data source — request body — body properties value value Verification

FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalAlways `verification`
Must equal: verification
verificationModelRequired within parentExpand Update a block — request body — body value type tab tab

Referenced models: Update a block — request body — body value type tab tab

Create a data source — response body — object data source parent

FieldTypePresenceDescription and constraints
$JSONRootThe parent of the data source. This is typically a database (`database_id`), but for externally synced data sources, can be another data source (`data_source_id`).
$ (anyOf 1)ModelAlternativeExpand Delete a view — response body — parent
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page parent type data source id

Referenced models: Update page — response body — object page parent type data source id, Delete a view — response body — parent

Create a data source — response body — object data source properties value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Create a data source — response body — object data source properties value description, id, name
$ (allOf 2)JSONAll variants apply
$ (allOf 2) (anyOf 1)ModelAlternativeExpand Create a data source — response body — object data source properties value value Number
$ (allOf 2) (anyOf 2)ModelAlternativeExpand Create a data source — response body — object data source properties value value Formula
$ (allOf 2) (anyOf 3)ModelAlternativeExpand Create a data source — response body — object data source properties value value Select
$ (allOf 2) (anyOf 4)ModelAlternativeExpand Create a data source — response body — object data source properties value value Multi Select
$ (allOf 2) (anyOf 5)ModelAlternativeExpand Create a data source — response body — object data source properties value value Status
$ (allOf 2) (anyOf 6)ModelAlternativeExpand Create a data source — response body — object data source properties value value Relation
$ (allOf 2) (anyOf 7)ModelAlternativeExpand Create a data source — response body — object data source properties value value Rollup
$ (allOf 2) (anyOf 8)ModelAlternativeExpand Create a data source — response body — object data source properties value value Unique Id
$ (allOf 2) (anyOf 9)ModelAlternativeExpand Create a data source — response body — object data source properties value value Title
$ (allOf 2) (anyOf 10)ModelAlternativeExpand Create a data source — response body — object data source properties value value Rich Text
$ (allOf 2) (anyOf 11)ModelAlternativeExpand Create a data source — response body — object data source properties value value Url
$ (allOf 2) (anyOf 12)ModelAlternativeExpand Create a data source — response body — object data source properties value value People
$ (allOf 2) (anyOf 13)ModelAlternativeExpand Create a data source — response body — object data source properties value value Files
$ (allOf 2) (anyOf 14)ModelAlternativeExpand Create a data source — response body — object data source properties value value Email
$ (allOf 2) (anyOf 15)ModelAlternativeExpand Create a data source — response body — object data source properties value value Phone Number
$ (allOf 2) (anyOf 16)ModelAlternativeExpand Create a data source — response body — object data source properties value value Date
$ (allOf 2) (anyOf 17)ModelAlternativeExpand Create a data source — response body — object data source properties value value Checkbox
$ (allOf 2) (anyOf 18)ModelAlternativeExpand Create a data source — response body — object data source properties value value Created By
$ (allOf 2) (anyOf 19)ModelAlternativeExpand Create a data source — response body — object data source properties value value Created Time
$ (allOf 2) (anyOf 20)ModelAlternativeExpand Create a data source — response body — object data source properties value value Last Edited By
$ (allOf 2) (anyOf 21)ModelAlternativeExpand Create a data source — response body — object data source properties value value Last Edited Time
$ (allOf 2) (anyOf 22)ModelAlternativeExpand Create a data source — response body — object data source properties value value Button
$ (allOf 2) (anyOf 23)ModelAlternativeExpand Create a data source — response body — object data source properties value value Place

Referenced models: Create a data source — response body — object data source properties value value Button, Create a data source — response body — object data source properties value value Checkbox, Create a data source — response body — object data source properties value value Created By, Create a data source — response body — object data source properties value value Created Time, Create a data source — response body — object data source properties value description, id, name, Create a data source — response body — object data source properties value value Date, Create a data source — response body — object data source properties value value Email, Create a data source — response body — object data source properties value value Files, Create a data source — response body — object data source properties value value Formula, Create a data source — response body — object data source properties value value Last Edited By, Create a data source — response body — object data source properties value value Last Edited Time, Create a data source — response body — object data source properties value value Multi Select, Create a data source — response body — object data source properties value value Number, Create a data source — response body — object data source properties value value People, Create a data source — response body — object data source properties value value Phone Number, Create a data source — response body — object data source properties value value Place, Create a data source — response body — object data source properties value value Relation, Create a data source — response body — object data source properties value value Rich Text, Create a data source — response body — object data source properties value value Rollup, Create a data source — response body — object data source properties value value Select, Create a data source — response body — object data source properties value value Status, Create a data source — response body — object data source properties value value Title, Create a data source — response body — object data source properties value value Unique Id, Create a data source — response body — object data source properties value value Url

Create a data source — response body — object data source properties value description, id, name

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
descriptionJSONRequired within parentThe description of the property.
description (anyOf 1)stringAlternativeMaximum length: 280
Minimum length: 1
description (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the property.
namestringRequired within parentThe name of the property.

Create a data source — response body — object data source properties value value Button

FieldTypePresenceDescription and constraints
$objectRoot
buttonModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringRequired within parentAlways `button`
Must equal: button

Referenced models: Update a block — request body — body value type tab tab

Create a data source — response body — object data source properties value value Checkbox

FieldTypePresenceDescription and constraints
$objectRoot
checkboxModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `checkbox`
Must equal: checkbox

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Created By

FieldTypePresenceDescription and constraints
$objectRoot
created_byModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `created_by`
Must equal: created_by

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Created Time

FieldTypePresenceDescription and constraints
$objectRoot
created_timeModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `created_time`
Must equal: created_time

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Date

FieldTypePresenceDescription and constraints
$objectRoot
dateModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `date`
Must equal: date

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Email

FieldTypePresenceDescription and constraints
$objectRoot
emailModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `email`
Must equal: email

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Files

FieldTypePresenceDescription and constraints
$objectRoot
filesModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `files`
Must equal: files

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Formula

FieldTypePresenceDescription and constraints
$objectRoot
formulaobjectRequired within parentAdditional keys: allowed
formula.expressionstringRequired within parent
typestringRequired within parentAlways `formula`
Must equal: formula

Create a data source — response body — object data source properties value value Last Edited By

FieldTypePresenceDescription and constraints
$objectRoot
last_edited_byModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `last_edited_by`
Must equal: last_edited_by

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Last Edited Time

FieldTypePresenceDescription and constraints
$objectRoot
last_edited_timeModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `last_edited_time`
Must equal: last_edited_time

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Multi Select

FieldTypePresenceDescription and constraints
$objectRoot
multi_selectobjectRequired within parentAdditional keys: allowed
multi_select.optionsarrayRequired within parentMaximum items: 100
multi_select.options[]ModelEach itemExpand Create a data source — response body — object data source properties value value Select select options item
typestringRequired within parentAlways `multi_select`
Must equal: multi_select

Referenced models: Create a data source — response body — object data source properties value value Select select options item

Create a data source — response body — object data source properties value value Number

FieldTypePresenceDescription and constraints
$objectRoot
numberobjectRequired within parentAdditional keys: allowed
number.formatstringRequired within parentThe number format for the property.
typestringRequired within parentAlways `number`
Must equal: number

Create a data source — response body — object data source properties value value People

FieldTypePresenceDescription and constraints
$objectRoot
peopleModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `people`
Must equal: people

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Phone Number

FieldTypePresenceDescription and constraints
$objectRoot
phone_numberModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `phone_number`
Must equal: phone_number

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Place

FieldTypePresenceDescription and constraints
$objectRoot
placeModelRequired within parentExpand Update a block — request body — body value type tab tab
typestringRequired within parentAlways `place`
Must equal: place

Referenced models: Update a block — request body — body value type tab tab

Create a data source — response body — object data source properties value value Relation

FieldTypePresenceDescription and constraints
$objectRoot
relationModelRequired within parentExpand Create a data source — response body — object data source properties value value Relation relation
typestringRequired within parentAlways `relation`
Must equal: relation

Referenced models: Create a data source — response body — object data source properties value value Relation relation

Create a data source — response body — object data source properties value value Relation relation

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Create a data source — response body — object data source properties value value Relation relation data source id, database id, limit
$ (allOf 2)JSONAll variants apply
$ (allOf 2) (anyOf 1)ModelAlternativeExpand Create a data source — response body — object data source properties value value Relation relation value Single Property
$ (allOf 2) (anyOf 2)ModelAlternativeExpand Create a data source — response body — object data source properties value value Relation relation value Dual Property

Referenced models: Create a data source — response body — object data source properties value value Relation relation data source id, database id, limit, Create a data source — response body — object data source properties value value Relation relation value Dual Property, Create a data source — response body — object data source properties value value Relation relation value Single Property

Create a data source — response body — object data source properties value value Relation relation data source id, database id, limit

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
data_source_idstringRequired within parentFormat: uuid
database_idstringRequired within parentFormat: uuid
limitJSONRequired within parentThe maximum number of pages each page can relate to, or null when there is no limit. Read-only.
limit (anyOf 1)JSONAlternative
limit (anyOf 1) (anyOf 1)integerAlternativeMinimum: 1
limit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
limit (anyOf 2)nullAlternative

Create a data source — response body — object data source properties value value Relation relation value Dual Property

FieldTypePresenceDescription and constraints
$objectRoot
dual_propertyobjectRequired within parentAdditional keys: allowed
dual_property.synced_property_idstringRequired within parent
dual_property.synced_property_namestringRequired within parent
typestringOptionalAlways `dual_property`
Must equal: dual_property

Create a data source — response body — object data source properties value value Relation relation value Single Property

FieldTypePresenceDescription and constraints
$objectRoot
single_propertyModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `single_property`
Must equal: single_property

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Rich Text

FieldTypePresenceDescription and constraints
$objectRoot
rich_textModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `rich_text`
Must equal: rich_text

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Rollup

FieldTypePresenceDescription and constraints
$objectRoot
rollupobjectRequired within parentAdditional keys: allowed
rollup.functionstringRequired within parentThe function to use for the rollup, e.g. count, count_values, percent_not_empty, max.
Known values: count, count_values, empty, not_empty, unique, show_unique, percent_empty, percent_not_empty, sum, average, median, min, max, range, earliest_date, latest_date, date_range, checked, unchecked, percent_checked, percent_unchecked, count_per_group, percent_per_group, show_original
rollup.relation_property_idstringRequired within parent
rollup.relation_property_namestringRequired within parent
rollup.rollup_property_idstringRequired within parent
rollup.rollup_property_namestringRequired within parent
typestringRequired within parentAlways `rollup`
Must equal: rollup

Create a data source — response body — object data source properties value value Select

FieldTypePresenceDescription and constraints
$objectRoot
selectobjectRequired within parentAdditional keys: allowed
select.optionsarrayRequired within parentMaximum items: 100
select.options[]ModelEach itemExpand Create a data source — response body — object data source properties value value Select select options item
typestringRequired within parentAlways `select`
Must equal: select

Referenced models: Create a data source — response body — object data source properties value value Select select options item

Create a data source — response body — object data source properties value value Select select options item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
colorstringRequired within parentOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
Known values: default, gray, brown, orange, yellow, green, blue, purple, pink, red
descriptionJSONRequired within parent
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
idstringRequired within parent
namestringRequired within parent

Create a data source — response body — object data source properties value value Status

FieldTypePresenceDescription and constraints
$objectRoot
statusobjectRequired within parentAdditional keys: allowed
status.default_optionJSONRequired within parentThe name of the configured default status option, or null when no default is configured. Read-only.
status.default_option (anyOf 1)stringAlternative
status.default_option (anyOf 2)nullAlternative
status.groupsarrayRequired within parentThe groups for the status property.
Maximum items: 100
status.groups[]objectEach itemAdditional keys: allowed
status.groups[].colorstringRequired within parentOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
The color of the status group.
Known values: default, gray, brown, orange, yellow, green, blue, purple, pink, red
status.groups[].idstringRequired within parentThe ID of the status group.
status.groups[].namestringRequired within parentThe name of the status group.
status.groups[].option_idsarrayRequired within parentThe IDs of the status options in this group.
Maximum items: 100
status.groups[].option_ids[]stringEach item
status.optionsarrayRequired within parentThe options for the status property.
Maximum items: 100
status.options[]ModelEach itemExpand Create a data source — response body — object data source properties value value Status status options item
typestringRequired within parentAlways `status`
Must equal: status

Referenced models: Create a data source — response body — object data source properties value value Status status options item

Create a data source — response body — object data source properties value value Status status options item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
colorstringRequired within parentOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
The color of the status option.
Known values: default, gray, brown, orange, yellow, green, blue, purple, pink, red
descriptionJSONRequired within parentThe description of the status option.
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the status option.
namestringRequired within parentThe name of the status option.

Create a data source — response body — object data source properties value value Title

FieldTypePresenceDescription and constraints
$objectRoot
titleModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `title`
Must equal: title

Referenced models: List views — response body — view

Create a data source — response body — object data source properties value value Unique Id

FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentAlways `unique_id`
Must equal: unique_id
unique_idobjectRequired within parentAdditional keys: allowed
unique_id.prefixJSONRequired within parentThe prefix for the unique ID.
unique_id.prefix (anyOf 1)stringAlternative
unique_id.prefix (anyOf 2)nullAlternative

Create a data source — response body — object data source properties value value Url

FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentAlways `url`
Must equal: url
urlModelRequired within parentExpand List views — response body — view

Referenced models: List views — response body — view

Create a data source — response body — object data source sync metadata sync state

FieldTypePresenceDescription and constraints
$objectRootStored state for a legacy synced data source. Missing or invalid timestamps are omitted. This is not a live health check.
Additional keys: allowed
last_sync_checkpoint_atstringOptionalStored legacy sync checkpoint time in UTC ISO 8601 format.
Format: date-time
last_sync_heartbeat_atstringOptionalStored legacy sync heartbeat time in UTC ISO 8601 format.
Format: date-time
last_synced_atstringOptionalStored legacy sync update time in UTC ISO 8601 format. This does not guarantee that all source changes have been imported.
Format: date-time
syncingJSONRequired within parentStored legacy sync state: true means syncing, false means not syncing, and row_limit_exceeded means the row limit stopped syncing. False does not guarantee a successful sync.
syncing (anyOf 1)booleanAlternative
syncing (anyOf 2)stringAlternativeAlways `row_limit_exceeded`
Must equal: row_limit_exceeded

Create a data source — response body — object data source — data Source Object Response

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
coverJSONRequired within parentThe cover of the data source.
cover (anyOf 1)ModelAlternativeExpand Update page — response body — object page cover value
cover (anyOf 2)nullAlternative
created_byModelRequired within parentExpand Update page — response body — object page created by
The user who created the data source.
created_timestringRequired within parentThe time when the data source was created.
Format: date-time
database_parentModelRequired within parentExpand Create a database — response body — object database parent
The parent of the data source's containing database. This is typically a page, block, or workspace, but can be another database in the case of wikis.
database_typeJSONRequired within parentThe type of typed database this data source belongs to, or `null` for a regular data source.
database_type (anyOf 1)stringAlternativeOne of: `tasks`, `projects`, `sprints`, `docs`, `wiki`, `meetings`, `meeting_notes`, `skills`, `github_prs`
Known values: tasks, projects, sprints, docs, wiki, meetings, meeting_notes, skills, github_prs
database_type (anyOf 2)nullAlternative
descriptionarrayRequired within parentThe description of the data source.
Maximum items: 100
description[]ModelEach itemExpand Retrieve a page property item — response body — value Title title
iconJSONRequired within parentThe icon of the data source.
icon (anyOf 1)ModelAlternativeExpand Get agent — response body — icon value
icon (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the data source.
Format: uuid
in_trashbooleanRequired within parentWhether the data source is in the trash.
is_inlinebooleanRequired within parentWhether the data source is inline.
last_edited_byModelRequired within parentExpand Update page — response body — object page created by
The user who last edited the data source.
last_edited_timestringRequired within parentThe time when the data source was last edited.
Format: date-time
objectstringRequired within parentThe data source object type name.
Must equal: data_source
parentModelRequired within parentExpand Create a data source — response body — object data source parent
The parent of the data source.
propertiesobjectRequired within parentThe properties schema of the data source.
Additional keys: see wildcard field
properties.*ModelAdditional keysExpand Create a data source — response body — object data source properties value
public_urlJSONRequired within parentThe public URL of the data source if it is publicly accessible.
public_url (anyOf 1)stringAlternative
public_url (anyOf 2)nullAlternative
sync_metadataobjectOptionalSync identity and available health, included when listing or retrieving data sources.
Additional keys: allowed
sync_metadata.external_collection_typestringOptionalThe provider of a legacy synced data source: Jira or Salesforce. Values are case-sensitive.
Known values: Jira, Salesforce
sync_metadata.external_database_syncobjectOptionalStored identity of an external database sync.
Additional keys: allowed
sync_metadata.external_database_sync.providerstringRequired within parentThe sync provider: github (GitHub), jira (Jira), or salesforce (Salesforce).
Known values: github, jira, salesforce
sync_metadata.external_database_sync.sync_idstringRequired within parentThe stored sync ID. This is not a credential.
Format: uuid
sync_metadata.healthJSONOptionalLive collection sync health. Null means unavailable, not unhealthy. Missing timestamps are unknown.
sync_metadata.health (anyOf 1)nullAlternative
sync_metadata.health (anyOf 2)ModelAlternativeExpand Create a data source — response body — object data_source / sync_metadata / health / ok False, stage: backfilling, initializing, steady
sync_metadata.health (anyOf 3)ModelAlternativeExpand Create a data source — response body — object data_source / sync_metadata / health / ok True, stage: backfilling, initializing, steady
sync_metadata.health (anyOf 4)objectAlternativeAdditional keys: allowed
sync_metadata.health (anyOf 4).pausedbooleanRequired within parentMust equal: true
sync_metadata.owner_user_idstringOptionalNotion user who owns the sync credential, included when health is available.
Format: uuid
sync_metadata.resourcestringOptionalProvider resource synced to this data source, when available.
sync_metadata.sync_idstringOptionalThe stored sync ID when provider details are unavailable. This is not a credential.
Format: uuid
sync_metadata.sync_stateModelOptionalExpand Create a data source — response body — object data source sync metadata sync state
sync_metadata.synced_collection_keystringOptionalOpaque, developer-defined collection key for a worker sync. It is not a globally unique ID or a credential. Worker status is not included.
titlearrayRequired within parentThe title of the data source.
Maximum items: 100
title[]ModelEach itemExpand Retrieve a page property item — response body — value Title title
urlstringRequired within parentThe URL of the data source.

Referenced models: Create a data source — response body — object data source properties value, Update page — response body — object page cover value, Get agent — response body — icon value, Create a data source — response body — object data source parent, Create a database — response body — object database parent, Update page — response body — object page created by, Retrieve a page property item — response body — value Title title, Create a data source — response body — object data_source / sync_metadata / health / ok False, stage: backfilling, initializing, steady, Create a data source — response body — object data_source / sync_metadata / health / ok True, stage: backfilling, initializing, steady, Create a data source — response body — object data source sync metadata sync state

Create a data source — response body — object data source — partial Data Source Object Response

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the data source.
Format: uuid
objectstringRequired within parentThe data source object type name.
Must equal: data_source
propertiesobjectRequired within parentThe properties schema of the data source.
Additional keys: see wildcard field
properties.*ModelAdditional keysExpand Create a data source — response body — object data source properties value

Referenced models: Create a data source — response body — object data source properties value

Create a data source — response body — object data_source / sync_metadata / health / ok False, stage: backfilling, initializing, steady

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
checksobjectRequired within parentAdditional keys: allowed
checks.delta_synced_through_atstringOptional
checks.last_execution_succeeded_atstringOptional
checks.sync_version_updated_atstringRequired within parent
errorobjectRequired within parentAdditional keys: allowed
error.codestringRequired within parent
error.severitystringRequired within parentKnown values: action_required, degraded, failing
okbooleanRequired within parentMust equal: false
pausedbooleanRequired within parent
stagestringRequired within parentKnown values: backfilling, initializing, steady

Create a data source — response body — object data_source / sync_metadata / health / ok True, stage: backfilling, initializing, steady

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
checksobjectRequired within parentAdditional keys: allowed
checks.delta_synced_through_atstringOptional
checks.last_execution_succeeded_atstringOptional
checks.sync_version_updated_atstringRequired within parent
okbooleanRequired within parentMust equal: true
pausedbooleanRequired within parent
stagestringRequired within parentKnown values: backfilling, initializing, steady

Query a data source — request body — body / filter / value / type verification / verification / does_not_equal: verified, expired, none

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
does_not_equalstringRequired within parentOne of: verified, expired, none

Query a data source — request body — body / filter / value / type verification / verification / status: verified, expired, none

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
statusstringRequired within parentOne of: verified, expired, none

Query a data source — request body — body filter

FieldTypePresenceDescription and constraints
$JSONRootA property filter, timestamp filter, or compound and/or filter.
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)objectAlternative
$ (anyOf 1) (anyOf 1).orModelRequired within parentExpand Query a data source — request body — body filter value or or
$ (anyOf 1) (anyOf 2)objectAlternative
$ (anyOf 1) (anyOf 2).andModelRequired within parentExpand Query a data source — request body — body filter value or or
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value — property Filter
$ (anyOf 3)ModelAlternativeExpand Query a data source — request body — body filter value — timestamp Filter

Referenced models: Query a data source — request body — body filter value or or, Query a data source — request body — body filter value — property Filter, Query a data source — request body — body filter value — timestamp Filter

Query a data source — request body — body filter value Created Time

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
created_timeModelRequired within parentExpand Query a data source — request body — body filter value type date date
timestampstringRequired within parentMust equal: created_time
typestringOptionalMust equal: created_time

Referenced models: Query a data source — request body — body filter value type date date

Query a data source — request body — body filter value Last Edited Time

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
last_edited_timeModelRequired within parentExpand Query a data source — request body — body filter value type date date
timestampstringRequired within parentMust equal: last_edited_time
typestringOptionalMust equal: last_edited_time

Referenced models: Query a data source — request body — body filter value type date date

Query a data source — request body — body filter value or or

FieldTypePresenceDescription and constraints
$arrayRootMaximum items: 100
$[]JSONEach item
$[] (anyOf 1)ModelAlternativeExpand Query a data source — request body — body filter value or or item value
$[] (anyOf 2)JSONAlternative
$[] (anyOf 2) (anyOf 1)objectAlternative
$[] (anyOf 2) (anyOf 1).orModelRequired within parentExpand Query a data source — request body — body filter value or or item value or or
$[] (anyOf 2) (anyOf 2)objectAlternative
$[] (anyOf 2) (anyOf 2).andModelRequired within parentExpand Query a data source — request body — body filter value or or item value or or

Referenced models: Query a data source — request body — body filter value or or item value, Query a data source — request body — body filter value or or item value or or

Query a data source — request body — body filter value or or item value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Query a data source — request body — body filter value — property Filter
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value — timestamp Filter

Referenced models: Query a data source — request body — body filter value — property Filter, Query a data source — request body — body filter value — timestamp Filter

Query a data source — request body — body filter value or or item value or or

FieldTypePresenceDescription and constraints
$arrayRootMaximum items: 100
$[]ModelEach itemExpand Query a data source — request body — body filter value or or item value

Referenced models: Query a data source — request body — body filter value or or item value

Query a data source — request body — body filter value type checkbox checkbox

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1).equalsbooleanRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2).does_not_equalbooleanRequired within parent

Query a data source — request body — body filter value type date date

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)objectAlternative
$ (anyOf 1) (anyOf 1).equalsModelRequired within parentExpand Query a data source — request body — body filter value type date date value after after
$ (anyOf 1) (anyOf 2)objectAlternative
$ (anyOf 1) (anyOf 2).beforeModelRequired within parentExpand Query a data source — request body — body filter value type date date value after after
$ (anyOf 1) (anyOf 3)objectAlternative
$ (anyOf 1) (anyOf 3).afterModelRequired within parentExpand Query a data source — request body — body filter value type date date value after after
$ (anyOf 1) (anyOf 4)objectAlternative
$ (anyOf 1) (anyOf 4).on_or_beforeModelRequired within parentExpand Query a data source — request body — body filter value type date date value after after
$ (anyOf 1) (anyOf 5)objectAlternative
$ (anyOf 1) (anyOf 5).on_or_afterModelRequired within parentExpand Query a data source — request body — body filter value type date date value after after
$ (anyOf 1) (anyOf 6)objectAlternative
$ (anyOf 1) (anyOf 6).this_weekModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 1) (anyOf 7)objectAlternative
$ (anyOf 1) (anyOf 7).past_weekModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 1) (anyOf 8)objectAlternative
$ (anyOf 1) (anyOf 8).past_monthModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 1) (anyOf 9)objectAlternative
$ (anyOf 1) (anyOf 9).past_yearModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 1) (anyOf 10)objectAlternative
$ (anyOf 1) (anyOf 10).next_weekModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 1) (anyOf 11)objectAlternative
$ (anyOf 1) (anyOf 11).next_monthModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 1) (anyOf 12)objectAlternative
$ (anyOf 1) (anyOf 12).next_yearModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value type files files

Referenced models: Update a block — request body — body value type tab tab, Query a data source — request body — body filter value type date date value after after, Query a data source — request body — body filter value type files files

Query a data source — request body — body filter value type date date value after after

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeFormat: date
$ (anyOf 2)stringAlternativeOne of: today, tomorrow, yesterday, one_week_ago, one_week_from_now, one_month_ago, one_month_from_now

Query a data source — request body — body filter value type files files

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1).is_emptybooleanRequired within parentMust equal: true
$ (anyOf 2)objectAlternative
$ (anyOf 2).is_not_emptybooleanRequired within parentMust equal: true

Query a data source — request body — body filter value type formula formula

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1).stringModelRequired within parentExpand Query a data source — request body — body filter value type url url
$ (anyOf 2)objectAlternative
$ (anyOf 2).checkboxModelRequired within parentExpand Query a data source — request body — body filter value type checkbox checkbox
$ (anyOf 3)objectAlternative
$ (anyOf 3).numberModelRequired within parentExpand Query a data source — request body — body filter value type number number
$ (anyOf 4)objectAlternative
$ (anyOf 4).dateModelRequired within parentExpand Query a data source — request body — body filter value type date date

Referenced models: Query a data source — request body — body filter value type checkbox checkbox, Query a data source — request body — body filter value type date date, Query a data source — request body — body filter value type number number, Query a data source — request body — body filter value type url url

Query a data source — request body — body filter value type multi select multi select

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)objectAlternative
$ (anyOf 1) (anyOf 1).containsModelRequired within parentExpand Query a data source — request body — body filter value type select select value equals equals
$ (anyOf 1) (anyOf 2)objectAlternative
$ (anyOf 1) (anyOf 2).does_not_containModelRequired within parentExpand Query a data source — request body — body filter value type select select value equals equals
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value type files files

Referenced models: Query a data source — request body — body filter value type files files, Query a data source — request body — body filter value type select select value equals equals

Query a data source — request body — body filter value type number number

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)objectAlternative
$ (anyOf 1) (anyOf 1).equalsnumberRequired within parent
$ (anyOf 1) (anyOf 2)objectAlternative
$ (anyOf 1) (anyOf 2).does_not_equalnumberRequired within parent
$ (anyOf 1) (anyOf 3)objectAlternative
$ (anyOf 1) (anyOf 3).greater_thannumberRequired within parent
$ (anyOf 1) (anyOf 4)objectAlternative
$ (anyOf 1) (anyOf 4).less_thannumberRequired within parent
$ (anyOf 1) (anyOf 5)objectAlternative
$ (anyOf 1) (anyOf 5).greater_than_or_equal_tonumberRequired within parent
$ (anyOf 1) (anyOf 6)objectAlternative
$ (anyOf 1) (anyOf 6).less_than_or_equal_tonumberRequired within parent
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value type files files

Referenced models: Query a data source — request body — body filter value type files files

Query a data source — request body — body filter value type people people

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)objectAlternative
$ (anyOf 1) (anyOf 1).containsModelRequired within parentExpand Query a data source — request body — body filter value type people people value contains contains
$ (anyOf 1) (anyOf 2)objectAlternative
$ (anyOf 1) (anyOf 2).does_not_containModelRequired within parentExpand Query a data source — request body — body filter value type people people value contains contains
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value type files files

Referenced models: Query a data source — request body — body filter value type files files, Query a data source — request body — body filter value type people people value contains contains

Query a data source — request body — body filter value type people people value contains contains

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternative
$ (anyOf 2)stringAlternativeMust equal: me

Query a data source — request body — body filter value type relation relation

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)objectAlternative
$ (anyOf 1) (anyOf 1).containsstringRequired within parent
$ (anyOf 1) (anyOf 2)objectAlternative
$ (anyOf 1) (anyOf 2).does_not_containstringRequired within parent
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value type files files

Referenced models: Query a data source — request body — body filter value type files files

Query a data source — request body — body filter value type rollup rollup

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1).anyModelRequired within parentExpand Query a data source — request body — body filter value type rollup rollup any any
$ (anyOf 2)objectAlternative
$ (anyOf 2).noneModelRequired within parentExpand Query a data source — request body — body filter value type rollup rollup any any
$ (anyOf 3)objectAlternative
$ (anyOf 3).everyModelRequired within parentExpand Query a data source — request body — body filter value type rollup rollup any any
$ (anyOf 4)objectAlternative
$ (anyOf 4).dateModelRequired within parentExpand Query a data source — request body — body filter value type date date
$ (anyOf 5)objectAlternative
$ (anyOf 5).numberModelRequired within parentExpand Query a data source — request body — body filter value type number number

Referenced models: Query a data source — request body — body filter value type date date, Query a data source — request body — body filter value type number number, Query a data source — request body — body filter value type rollup rollup any any

Query a data source — request body — body filter value type rollup rollup any any

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1).rich_textModelRequired within parentExpand Query a data source — request body — body filter value type url url
$ (anyOf 2)objectAlternative
$ (anyOf 2).numberModelRequired within parentExpand Query a data source — request body — body filter value type number number
$ (anyOf 3)objectAlternative
$ (anyOf 3).checkboxModelRequired within parentExpand Query a data source — request body — body filter value type checkbox checkbox
$ (anyOf 4)objectAlternative
$ (anyOf 4).selectModelRequired within parentExpand Query a data source — request body — body filter value type select select
$ (anyOf 5)objectAlternative
$ (anyOf 5).multi_selectModelRequired within parentExpand Query a data source — request body — body filter value type multi select multi select
$ (anyOf 6)objectAlternative
$ (anyOf 6).relationModelRequired within parentExpand Query a data source — request body — body filter value type relation relation
$ (anyOf 7)objectAlternative
$ (anyOf 7).dateModelRequired within parentExpand Query a data source — request body — body filter value type date date
$ (anyOf 8)objectAlternative
$ (anyOf 8).peopleModelRequired within parentExpand Query a data source — request body — body filter value type people people
$ (anyOf 9)objectAlternative
$ (anyOf 9).filesModelRequired within parentExpand Query a data source — request body — body filter value type files files
$ (anyOf 10)objectAlternative
$ (anyOf 10).statusModelRequired within parentExpand Query a data source — request body — body filter value type status status

Referenced models: Query a data source — request body — body filter value type checkbox checkbox, Query a data source — request body — body filter value type date date, Query a data source — request body — body filter value type files files, Query a data source — request body — body filter value type multi select multi select, Query a data source — request body — body filter value type number number, Query a data source — request body — body filter value type people people, Query a data source — request body — body filter value type relation relation, Query a data source — request body — body filter value type select select, Query a data source — request body — body filter value type status status, Query a data source — request body — body filter value type url url

Query a data source — request body — body filter value type select select

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)objectAlternative
$ (anyOf 1) (anyOf 1).equalsModelRequired within parentExpand Query a data source — request body — body filter value type select select value equals equals
$ (anyOf 1) (anyOf 2)objectAlternative
$ (anyOf 1) (anyOf 2).does_not_equalModelRequired within parentExpand Query a data source — request body — body filter value type select select value equals equals
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value type files files

Referenced models: Query a data source — request body — body filter value type files files, Query a data source — request body — body filter value type select select value equals equals

Query a data source — request body — body filter value type select select value equals equals

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternative
$ (anyOf 2)arrayAlternative
$ (anyOf 2)[]stringEach item

Query a data source — request body — body filter value type status status

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Query a data source — request body — body filter value type status status value
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value type files files

Referenced models: Query a data source — request body — body filter value type files files, Query a data source — request body — body filter value type status status value

Query a data source — request body — body filter value type status status value

FieldTypePresenceDescription and constraints
$JSONRootThe group operators match status groups instead of options. They require the `Notion-Beta: status-group-filters-2026-10-06` header.
$ (anyOf 1)objectAlternative
$ (anyOf 1).equalsModelRequired within parentExpand Query a data source — request body — body filter value type select select value equals equals
$ (anyOf 2)objectAlternative
$ (anyOf 2).does_not_equalModelRequired within parentExpand Query a data source — request body — body filter value type select select value equals equals
$ (anyOf 3)objectAlternative
$ (anyOf 3).group_equalsModelRequired within parentExpand Query a data source — request body — body filter value type status status value group equals group equals
$ (anyOf 4)objectAlternative
$ (anyOf 4).group_does_not_equalModelRequired within parentExpand Query a data source — request body — body filter value type status status value group equals group equals

Referenced models: Query a data source — request body — body filter value type status status value group equals group equals, Query a data source — request body — body filter value type select select value equals equals

Query a data source — request body — body filter value type status status value group equals group equals

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeMaximum length: 100
Minimum length: 1
$ (anyOf 2)arrayAlternativeMaximum items: 100
Minimum items: 1
$ (anyOf 2)[]stringEach itemMaximum length: 100
Minimum length: 1

Query a data source — request body — body filter value type url url

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)JSONAlternative
$ (anyOf 1) (anyOf 1)objectAlternative
$ (anyOf 1) (anyOf 1).equalsstringRequired within parent
$ (anyOf 1) (anyOf 2)objectAlternative
$ (anyOf 1) (anyOf 2).does_not_equalstringRequired within parent
$ (anyOf 1) (anyOf 3)objectAlternative
$ (anyOf 1) (anyOf 3).containsstringRequired within parent
$ (anyOf 1) (anyOf 4)objectAlternative
$ (anyOf 1) (anyOf 4).does_not_containstringRequired within parent
$ (anyOf 1) (anyOf 5)objectAlternative
$ (anyOf 1) (anyOf 5).starts_withstringRequired within parent
$ (anyOf 1) (anyOf 6)objectAlternative
$ (anyOf 1) (anyOf 6).ends_withstringRequired within parent
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value type files files

Referenced models: Query a data source — request body — body filter value type files files

Query a data source — request body — body filter value — property Filter

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeAdditional keys: not allowed
$ (anyOf 1).propertystringRequired within parent
$ (anyOf 1).titleModelRequired within parentExpand Query a data source — request body — body filter value type url url
$ (anyOf 1).typestringOptionalMust equal: title
$ (anyOf 2)objectAlternativeAdditional keys: not allowed
$ (anyOf 2).propertystringRequired within parent
$ (anyOf 2).rich_textModelRequired within parentExpand Query a data source — request body — body filter value type url url
$ (anyOf 2).typestringOptionalMust equal: rich_text
$ (anyOf 3)objectAlternativeAdditional keys: not allowed
$ (anyOf 3).numberModelRequired within parentExpand Query a data source — request body — body filter value type number number
$ (anyOf 3).propertystringRequired within parent
$ (anyOf 3).typestringOptionalMust equal: number
$ (anyOf 4)objectAlternativeAdditional keys: not allowed
$ (anyOf 4).checkboxModelRequired within parentExpand Query a data source — request body — body filter value type checkbox checkbox
$ (anyOf 4).propertystringRequired within parent
$ (anyOf 4).typestringOptionalMust equal: checkbox
$ (anyOf 5)objectAlternativeAdditional keys: not allowed
$ (anyOf 5).propertystringRequired within parent
$ (anyOf 5).selectModelRequired within parentExpand Query a data source — request body — body filter value type select select
$ (anyOf 5).typestringOptionalMust equal: select
$ (anyOf 6)objectAlternativeAdditional keys: not allowed
$ (anyOf 6).multi_selectModelRequired within parentExpand Query a data source — request body — body filter value type multi select multi select
$ (anyOf 6).propertystringRequired within parent
$ (anyOf 6).typestringOptionalMust equal: multi_select
$ (anyOf 7)objectAlternativeAdditional keys: not allowed
$ (anyOf 7).propertystringRequired within parent
$ (anyOf 7).statusModelRequired within parentExpand Query a data source — request body — body filter value type status status
$ (anyOf 7).typestringOptionalMust equal: status
$ (anyOf 8)objectAlternativeAdditional keys: not allowed
$ (anyOf 8).dateModelRequired within parentExpand Query a data source — request body — body filter value type date date
$ (anyOf 8).propertystringRequired within parent
$ (anyOf 8).typestringOptionalMust equal: date
$ (anyOf 9)objectAlternativeAdditional keys: not allowed
$ (anyOf 9).peopleModelRequired within parentExpand Query a data source — request body — body filter value type people people
$ (anyOf 9).propertystringRequired within parent
$ (anyOf 9).typestringOptionalMust equal: people
$ (anyOf 10)objectAlternativeAdditional keys: not allowed
$ (anyOf 10).filesModelRequired within parentExpand Query a data source — request body — body filter value type files files
$ (anyOf 10).propertystringRequired within parent
$ (anyOf 10).typestringOptionalMust equal: files
$ (anyOf 11)objectAlternativeAdditional keys: not allowed
$ (anyOf 11).propertystringRequired within parent
$ (anyOf 11).typestringOptionalMust equal: url
$ (anyOf 11).urlModelRequired within parentExpand Query a data source — request body — body filter value type url url
$ (anyOf 12)objectAlternativeAdditional keys: not allowed
$ (anyOf 12).emailModelRequired within parentExpand Query a data source — request body — body filter value type url url
$ (anyOf 12).propertystringRequired within parent
$ (anyOf 12).typestringOptionalMust equal: email
$ (anyOf 13)objectAlternativeAdditional keys: not allowed
$ (anyOf 13).phone_numberModelRequired within parentExpand Query a data source — request body — body filter value type url url
$ (anyOf 13).propertystringRequired within parent
$ (anyOf 13).typestringOptionalMust equal: phone_number
$ (anyOf 14)objectAlternativeAdditional keys: not allowed
$ (anyOf 14).propertystringRequired within parent
$ (anyOf 14).relationModelRequired within parentExpand Query a data source — request body — body filter value type relation relation
$ (anyOf 14).typestringOptionalMust equal: relation
$ (anyOf 15)objectAlternativeAdditional keys: not allowed
$ (anyOf 15).created_byModelRequired within parentExpand Query a data source — request body — body filter value type people people
$ (anyOf 15).propertystringRequired within parent
$ (anyOf 15).typestringOptionalMust equal: created_by
$ (anyOf 16)objectAlternativeAdditional keys: not allowed
$ (anyOf 16).created_timeModelRequired within parentExpand Query a data source — request body — body filter value type date date
$ (anyOf 16).propertystringRequired within parent
$ (anyOf 16).typestringOptionalMust equal: created_time
$ (anyOf 17)objectAlternativeAdditional keys: not allowed
$ (anyOf 17).last_edited_byModelRequired within parentExpand Query a data source — request body — body filter value type people people
$ (anyOf 17).propertystringRequired within parent
$ (anyOf 17).typestringOptionalMust equal: last_edited_by
$ (anyOf 18)objectAlternativeAdditional keys: not allowed
$ (anyOf 18).last_edited_timeModelRequired within parentExpand Query a data source — request body — body filter value type date date
$ (anyOf 18).propertystringRequired within parent
$ (anyOf 18).typestringOptionalMust equal: last_edited_time
$ (anyOf 19)objectAlternativeAdditional keys: not allowed
$ (anyOf 19).formulaModelRequired within parentExpand Query a data source — request body — body filter value type formula formula
$ (anyOf 19).propertystringRequired within parent
$ (anyOf 19).typestringOptionalMust equal: formula
$ (anyOf 20)objectAlternativeAdditional keys: not allowed
$ (anyOf 20).propertystringRequired within parent
$ (anyOf 20).typestringOptionalMust equal: unique_id
$ (anyOf 20).unique_idModelRequired within parentExpand Query a data source — request body — body filter value type number number
$ (anyOf 21)objectAlternativeAdditional keys: not allowed
$ (anyOf 21).propertystringRequired within parent
$ (anyOf 21).rollupModelRequired within parentExpand Query a data source — request body — body filter value type rollup rollup
$ (anyOf 21).typestringOptionalMust equal: rollup
$ (anyOf 22)objectAlternativeAdditional keys: not allowed
$ (anyOf 22).propertystringRequired within parent
$ (anyOf 22).typestringOptionalMust equal: verification
$ (anyOf 22).verificationJSONRequired within parent
$ (anyOf 22).verification (anyOf 1)ModelAlternativeExpand Query a data source — request body — body / filter / value / type verification / verification / status: verified, expired, none
$ (anyOf 22).verification (anyOf 2)ModelAlternativeExpand Query a data source — request body — body / filter / value / type verification / verification / does_not_equal: verified, expired, none

Referenced models: Query a data source — request body — body filter value type checkbox checkbox, Query a data source — request body — body filter value type date date, Query a data source — request body — body filter value type files files, Query a data source — request body — body filter value type formula formula, Query a data source — request body — body filter value type multi select multi select, Query a data source — request body — body filter value type number number, Query a data source — request body — body filter value type people people, Query a data source — request body — body filter value type relation relation, Query a data source — request body — body filter value type rollup rollup, Query a data source — request body — body filter value type select select, Query a data source — request body — body filter value type status status, Query a data source — request body — body filter value type url url, Query a data source — request body — body / filter / value / type verification / verification / does_not_equal: verified, expired, none, Query a data source — request body — body / filter / value / type verification / verification / status: verified, expired, none

Query a data source — request body — body filter value — timestamp Filter

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Query a data source — request body — body filter value Created Time
$ (anyOf 2)ModelAlternativeExpand Query a data source — request body — body filter value Last Edited Time

Referenced models: Query a data source — request body — body filter value Created Time, Query a data source — request body — body filter value Last Edited Time

Query a data source — request body — body sorts item

FieldTypePresenceDescription and constraints
$JSONRootSort by property name or ID, or by timestamp.
$ (anyOf 1)objectAlternative
$ (anyOf 1).directionstringRequired within parentOne of: ascending, descending
$ (anyOf 1).propertystringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2).directionstringRequired within parentOne of: ascending, descending
$ (anyOf 2).timestampstringRequired within parentOne of: created_time, last_edited_time

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.