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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
database_id | string | Required within parent | The ID of the parent database (with or without dashes), for example, 195de9221179449fab8075a27c979105 |
type | string | Optional | Always `database_id` Must equal: database_id |
Create a data source — request body — body properties value
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | The description of the property. |
description (oneOf 1) | string | Alternative | Maximum length: 280 Minimum length: 1 |
description (oneOf 2) | null | Alternative |
Create a data source — request body — body properties value value Button
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
button | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
checkbox | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_time | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
files | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
formula | object | Required within parent | |
formula.expression | string | Optional | |
type | string | Optional | Always `formula` Must equal: formula |
Create a data source — request body — body properties value value Last Edited By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
last_edited_by | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
last_edited_time | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
last_visited_time | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
location | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
multi_select | object | Required within parent | |
multi_select.options | array | Optional | Maximum items: 100 |
multi_select.options[] | object | Each item | |
multi_select.options[].color | string | Optional | One 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[].description | JSON | Optional | |
multi_select.options[].description (oneOf 1) | string | Alternative | |
multi_select.options[].description (oneOf 2) | null | Alternative | |
multi_select.options[].name | string | Required within parent | |
type | string | Optional | Always `multi_select` Must equal: multi_select |
Create a data source — request body — body properties value value Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
number | object | Required within parent | |
number.format | string | Optional | |
type | string | Optional | Always `number` Must equal: number |
Create a data source — request body — body properties value value People
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
people | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
phone_number | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
place | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
relation | JSON | Required within parent | |
relation (allOf 1) | object | All variants apply | |
relation (allOf 1).data_source_id | string | Required within parent | |
relation (allOf 2) | JSON | All variants apply | |
relation (allOf 2) (oneOf 1) | object | Alternative | |
relation (allOf 2) (oneOf 1).single_property | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
relation (allOf 2) (oneOf 1).type | string | Optional | Always `single_property` Must equal: single_property |
relation (allOf 2) (oneOf 2) | object | Alternative | |
relation (allOf 2) (oneOf 2).dual_property | object | Required within parent | |
relation (allOf 2) (oneOf 2).dual_property.synced_property_id | string | Optional | |
relation (allOf 2) (oneOf 2).dual_property.synced_property_name | string | Optional | |
relation (allOf 2) (oneOf 2).type | string | Optional | Always `dual_property` Must equal: dual_property |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
rich_text | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
rollup | JSON | Required within parent | |
rollup (allOf 1) | object | All variants apply | |
rollup (allOf 1).function | string | Required within parent | The 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) | JSON | All variants apply | |
rollup (allOf 2) (oneOf 1) | object | Alternative | |
rollup (allOf 2) (oneOf 1).relation_property_name | string | Required within parent | |
rollup (allOf 2) (oneOf 1).rollup_property_name | string | Required within parent | |
rollup (allOf 2) (oneOf 2) | object | Alternative | |
rollup (allOf 2) (oneOf 2).relation_property_id | string | Required within parent | |
rollup (allOf 2) (oneOf 2).rollup_property_name | string | Required within parent | |
rollup (allOf 2) (oneOf 3) | object | Alternative | |
rollup (allOf 2) (oneOf 3).relation_property_name | string | Required within parent | |
rollup (allOf 2) (oneOf 3).rollup_property_id | string | Required within parent | |
rollup (allOf 2) (oneOf 4) | object | Alternative | |
rollup (allOf 2) (oneOf 4).relation_property_id | string | Required within parent | |
rollup (allOf 2) (oneOf 4).rollup_property_id | string | Required within parent | |
type | string | Optional | Always `rollup` Must equal: rollup |
Create a data source — request body — body properties value value Select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
select | object | Required within parent | |
select.options | array | Optional | Maximum items: 100 |
select.options[] | object | Each item | |
select.options[].color | string | Optional | One 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[].description | JSON | Optional | |
select.options[].description (oneOf 1) | string | Alternative | |
select.options[].description (oneOf 2) | null | Alternative | |
select.options[].name | string | Required within parent | |
type | string | Optional | Always `select` Must equal: select |
Create a data source — request body — body properties value value Status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | Model | Required within parent | Expand Create a data source — request body — body properties value value Status status |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
options | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | Maximum items: 100 |
$[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | string | Optional | One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red` One of: default, gray, brown, orange, yellow, green, blue, purple, pink, red |
description | JSON | Optional | |
description (oneOf 1) | string | Alternative | |
description (oneOf 2) | null | Alternative | |
group | string | Optional | One of: `To-do`, `In progress`, `Complete` One of: To-do, In progress, Complete |
name | string | Required within parent |
Create a data source — request body — body properties value value Title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
title | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Optional | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Always `unique_id` Must equal: unique_id |
unique_id | object | Required within parent | |
unique_id.prefix | JSON | Optional | |
unique_id.prefix (oneOf 1) | string | Alternative | |
unique_id.prefix (oneOf 2) | null | Alternative |
Create a data source — request body — body properties value value Url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Always `url` Must equal: url |
url | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Optional | Always `verification` Must equal: verification |
verification | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The 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) | Model | Alternative | Expand Delete a view — response body — parent |
$ (anyOf 2) | Model | Alternative | Expand 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
description | JSON | Required within parent | The description of the property. |
description (anyOf 1) | string | Alternative | Maximum length: 280 Minimum length: 1 |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | The ID of the property. |
name | string | Required within parent | The name of the property. |
Create a data source — response body — object data source properties value value Button
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
button | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
checkbox | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_time | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `date` Must equal: date |
Referenced models: List views — response body — view
Create a data source — response body — object data source properties value value Email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `email` Must equal: email |
Referenced models: List views — response body — view
Create a data source — response body — object data source properties value value Files
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
files | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `files` Must equal: files |
Referenced models: List views — response body — view
Create a data source — response body — object data source properties value value Formula
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
formula | object | Required within parent | Additional keys: allowed |
formula.expression | string | Required within parent | |
type | string | Required within parent | Always `formula` Must equal: formula |
Create a data source — response body — object data source properties value value Last Edited By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
last_edited_by | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
last_edited_time | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
multi_select | object | Required within parent | Additional keys: allowed |
multi_select.options | array | Required within parent | Maximum items: 100 |
multi_select.options[] | Model | Each item | Expand Create a data source — response body — object data source properties value value Select select options item |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
number | object | Required within parent | Additional keys: allowed |
number.format | string | Required within parent | The number format for the property. |
type | string | Required within parent | Always `number` Must equal: number |
Create a data source — response body — object data source properties value value People
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
people | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
phone_number | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
place | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
relation | Model | Required within parent | Expand Create a data source — response body — object data source properties value value Relation relation |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Create a data source — response body — object data source properties value value Relation relation data source id, database id, limit |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2) (anyOf 1) | Model | Alternative | Expand Create a data source — response body — object data source properties value value Relation relation value Single Property |
$ (allOf 2) (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
data_source_id | string | Required within parent | Format: uuid |
database_id | string | Required within parent | Format: uuid |
limit | JSON | Required within parent | The maximum number of pages each page can relate to, or null when there is no limit. Read-only. |
limit (anyOf 1) | JSON | Alternative | |
limit (anyOf 1) (anyOf 1) | integer | Alternative | Minimum: 1 |
limit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
limit (anyOf 2) | null | Alternative |
Create a data source — response body — object data source properties value value Relation relation value Dual Property
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dual_property | object | Required within parent | Additional keys: allowed |
dual_property.synced_property_id | string | Required within parent | |
dual_property.synced_property_name | string | Required within parent | |
type | string | Optional | Always `dual_property` Must equal: dual_property |
Create a data source — response body — object data source properties value value Relation relation value Single Property
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
single_property | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
rich_text | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
rollup | object | Required within parent | Additional keys: allowed |
rollup.function | string | Required within parent | The 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_id | string | Required within parent | |
rollup.relation_property_name | string | Required within parent | |
rollup.rollup_property_id | string | Required within parent | |
rollup.rollup_property_name | string | Required within parent | |
type | string | Required within parent | Always `rollup` Must equal: rollup |
Create a data source — response body — object data source properties value value Select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
select | object | Required within parent | Additional keys: allowed |
select.options | array | Required within parent | Maximum items: 100 |
select.options[] | Model | Each item | Expand Create a data source — response body — object data source properties value value Select select options item |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
color | string | Required within parent | One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red` Known values: default, gray, brown, orange, yellow, green, blue, purple, pink, red |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
name | string | Required within parent |
Create a data source — response body — object data source properties value value Status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | object | Required within parent | Additional keys: allowed |
status.default_option | JSON | Required within parent | The name of the configured default status option, or null when no default is configured. Read-only. |
status.default_option (anyOf 1) | string | Alternative | |
status.default_option (anyOf 2) | null | Alternative | |
status.groups | array | Required within parent | The groups for the status property. Maximum items: 100 |
status.groups[] | object | Each item | Additional keys: allowed |
status.groups[].color | string | Required within parent | One 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[].id | string | Required within parent | The ID of the status group. |
status.groups[].name | string | Required within parent | The name of the status group. |
status.groups[].option_ids | array | Required within parent | The IDs of the status options in this group. Maximum items: 100 |
status.groups[].option_ids[] | string | Each item | |
status.options | array | Required within parent | The options for the status property. Maximum items: 100 |
status.options[] | Model | Each item | Expand Create a data source — response body — object data source properties value value Status status options item |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
color | string | Required within parent | One 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 |
description | JSON | Required within parent | The description of the status option. |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | The ID of the status option. |
name | string | Required within parent | The name of the status option. |
Create a data source — response body — object data source properties value value Title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
title | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Always `unique_id` Must equal: unique_id |
unique_id | object | Required within parent | Additional keys: allowed |
unique_id.prefix | JSON | Required within parent | The prefix for the unique ID. |
unique_id.prefix (anyOf 1) | string | Alternative | |
unique_id.prefix (anyOf 2) | null | Alternative |
Create a data source — response body — object data source properties value value Url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Always `url` Must equal: url |
url | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Stored 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_at | string | Optional | Stored legacy sync checkpoint time in UTC ISO 8601 format. Format: date-time |
last_sync_heartbeat_at | string | Optional | Stored legacy sync heartbeat time in UTC ISO 8601 format. Format: date-time |
last_synced_at | string | Optional | Stored legacy sync update time in UTC ISO 8601 format. This does not guarantee that all source changes have been imported. Format: date-time |
syncing | JSON | Required within parent | Stored 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) | boolean | Alternative | |
syncing (anyOf 2) | string | Alternative | Always `row_limit_exceeded` Must equal: row_limit_exceeded |
Create a data source — response body — object data source — data Source Object Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
cover | JSON | Required within parent | The cover of the data source. |
cover (anyOf 1) | Model | Alternative | Expand Update page — response body — object page cover value |
cover (anyOf 2) | null | Alternative | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by The user who created the data source. |
created_time | string | Required within parent | The time when the data source was created. Format: date-time |
database_parent | Model | Required within parent | Expand 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_type | JSON | Required within parent | The type of typed database this data source belongs to, or `null` for a regular data source. |
database_type (anyOf 1) | string | Alternative | One 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) | null | Alternative | |
description | array | Required within parent | The description of the data source. Maximum items: 100 |
description[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
icon | JSON | Required within parent | The icon of the data source. |
icon (anyOf 1) | Model | Alternative | Expand Get agent — response body — icon value |
icon (anyOf 2) | null | Alternative | |
id | string | Required within parent | The ID of the data source. Format: uuid |
in_trash | boolean | Required within parent | Whether the data source is in the trash. |
is_inline | boolean | Required within parent | Whether the data source is inline. |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by The user who last edited the data source. |
last_edited_time | string | Required within parent | The time when the data source was last edited. Format: date-time |
object | string | Required within parent | The data source object type name. Must equal: data_source |
parent | Model | Required within parent | Expand Create a data source — response body — object data source parent The parent of the data source. |
properties | object | Required within parent | The properties schema of the data source. Additional keys: see wildcard field |
properties.* | Model | Additional keys | Expand Create a data source — response body — object data source properties value |
public_url | JSON | Required within parent | The public URL of the data source if it is publicly accessible. |
public_url (anyOf 1) | string | Alternative | |
public_url (anyOf 2) | null | Alternative | |
sync_metadata | object | Optional | Sync identity and available health, included when listing or retrieving data sources. Additional keys: allowed |
sync_metadata.external_collection_type | string | Optional | The provider of a legacy synced data source: Jira or Salesforce. Values are case-sensitive. Known values: Jira, Salesforce |
sync_metadata.external_database_sync | object | Optional | Stored identity of an external database sync. Additional keys: allowed |
sync_metadata.external_database_sync.provider | string | Required within parent | The sync provider: github (GitHub), jira (Jira), or salesforce (Salesforce). Known values: github, jira, salesforce |
sync_metadata.external_database_sync.sync_id | string | Required within parent | The stored sync ID. This is not a credential. Format: uuid |
sync_metadata.health | JSON | Optional | Live collection sync health. Null means unavailable, not unhealthy. Missing timestamps are unknown. |
sync_metadata.health (anyOf 1) | null | Alternative | |
sync_metadata.health (anyOf 2) | Model | Alternative | Expand Create a data source — response body — object data_source / sync_metadata / health / ok False, stage: backfilling, initializing, steady |
sync_metadata.health (anyOf 3) | Model | Alternative | Expand Create a data source — response body — object data_source / sync_metadata / health / ok True, stage: backfilling, initializing, steady |
sync_metadata.health (anyOf 4) | object | Alternative | Additional keys: allowed |
sync_metadata.health (anyOf 4).paused | boolean | Required within parent | Must equal: true |
sync_metadata.owner_user_id | string | Optional | Notion user who owns the sync credential, included when health is available. Format: uuid |
sync_metadata.resource | string | Optional | Provider resource synced to this data source, when available. |
sync_metadata.sync_id | string | Optional | The stored sync ID when provider details are unavailable. This is not a credential. Format: uuid |
sync_metadata.sync_state | Model | Optional | Expand Create a data source — response body — object data source sync metadata sync state |
sync_metadata.synced_collection_key | string | Optional | Opaque, developer-defined collection key for a worker sync. It is not a globally unique ID or a credential. Worker status is not included. |
title | array | Required within parent | The title of the data source. Maximum items: 100 |
title[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
url | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of the data source. Format: uuid |
object | string | Required within parent | The data source object type name. Must equal: data_source |
properties | object | Required within parent | The properties schema of the data source. Additional keys: see wildcard field |
properties.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
checks | object | Required within parent | Additional keys: allowed |
checks.delta_synced_through_at | string | Optional | |
checks.last_execution_succeeded_at | string | Optional | |
checks.sync_version_updated_at | string | Required within parent | |
error | object | Required within parent | Additional keys: allowed |
error.code | string | Required within parent | |
error.severity | string | Required within parent | Known values: action_required, degraded, failing |
ok | boolean | Required within parent | Must equal: false |
paused | boolean | Required within parent | |
stage | string | Required within parent | Known values: backfilling, initializing, steady |
Create a data source — response body — object data_source / sync_metadata / health / ok True, stage: backfilling, initializing, steady
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
checks | object | Required within parent | Additional keys: allowed |
checks.delta_synced_through_at | string | Optional | |
checks.last_execution_succeeded_at | string | Optional | |
checks.sync_version_updated_at | string | Required within parent | |
ok | boolean | Required within parent | Must equal: true |
paused | boolean | Required within parent | |
stage | string | Required within parent | Known values: backfilling, initializing, steady |
Query a data source — request body — body / filter / value / type verification / verification / does_not_equal: verified, expired, none
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
does_not_equal | string | Required within parent | One of: verified, expired, none |
Query a data source — request body — body / filter / value / type verification / verification / status: verified, expired, none
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
status | string | Required within parent | One of: verified, expired, none |
Query a data source — request body — body filter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | A property filter, timestamp filter, or compound and/or filter. |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 1) (anyOf 1) | object | Alternative | |
$ (anyOf 1) (anyOf 1).or | Model | Required within parent | Expand Query a data source — request body — body filter value or or |
$ (anyOf 1) (anyOf 2) | object | Alternative | |
$ (anyOf 1) (anyOf 2).and | Model | Required within parent | Expand Query a data source — request body — body filter value or or |
$ (anyOf 2) | Model | Alternative | Expand Query a data source — request body — body filter value — property Filter |
$ (anyOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
created_time | Model | Required within parent | Expand Query a data source — request body — body filter value type date date |
timestamp | string | Required within parent | Must equal: created_time |
type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
last_edited_time | Model | Required within parent | Expand Query a data source — request body — body filter value type date date |
timestamp | string | Required within parent | Must equal: last_edited_time |
type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | Maximum items: 100 |
$[] | JSON | Each item | |
$[] (anyOf 1) | Model | Alternative | Expand Query a data source — request body — body filter value or or item value |
$[] (anyOf 2) | JSON | Alternative | |
$[] (anyOf 2) (anyOf 1) | object | Alternative | |
$[] (anyOf 2) (anyOf 1).or | Model | Required within parent | Expand Query a data source — request body — body filter value or or item value or or |
$[] (anyOf 2) (anyOf 2) | object | Alternative | |
$[] (anyOf 2) (anyOf 2).and | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Query a data source — request body — body filter value — property Filter |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | Maximum items: 100 |
$[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1).equals | boolean | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2).does_not_equal | boolean | Required within parent |
Query a data source — request body — body filter value type date date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 1) (anyOf 1) | object | Alternative | |
$ (anyOf 1) (anyOf 1).equals | Model | Required within parent | Expand Query a data source — request body — body filter value type date date value after after |
$ (anyOf 1) (anyOf 2) | object | Alternative | |
$ (anyOf 1) (anyOf 2).before | Model | Required within parent | Expand Query a data source — request body — body filter value type date date value after after |
$ (anyOf 1) (anyOf 3) | object | Alternative | |
$ (anyOf 1) (anyOf 3).after | Model | Required within parent | Expand Query a data source — request body — body filter value type date date value after after |
$ (anyOf 1) (anyOf 4) | object | Alternative | |
$ (anyOf 1) (anyOf 4).on_or_before | Model | Required within parent | Expand Query a data source — request body — body filter value type date date value after after |
$ (anyOf 1) (anyOf 5) | object | Alternative | |
$ (anyOf 1) (anyOf 5).on_or_after | Model | Required within parent | Expand Query a data source — request body — body filter value type date date value after after |
$ (anyOf 1) (anyOf 6) | object | Alternative | |
$ (anyOf 1) (anyOf 6).this_week | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 1) (anyOf 7) | object | Alternative | |
$ (anyOf 1) (anyOf 7).past_week | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 1) (anyOf 8) | object | Alternative | |
$ (anyOf 1) (anyOf 8).past_month | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 1) (anyOf 9) | object | Alternative | |
$ (anyOf 1) (anyOf 9).past_year | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 1) (anyOf 10) | object | Alternative | |
$ (anyOf 1) (anyOf 10).next_week | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 1) (anyOf 11) | object | Alternative | |
$ (anyOf 1) (anyOf 11).next_month | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 1) (anyOf 12) | object | Alternative | |
$ (anyOf 1) (anyOf 12).next_year | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Format: date |
$ (anyOf 2) | string | Alternative | One 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1).is_empty | boolean | Required within parent | Must equal: true |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2).is_not_empty | boolean | Required within parent | Must equal: true |
Query a data source — request body — body filter value type formula formula
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1).string | Model | Required within parent | Expand Query a data source — request body — body filter value type url url |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2).checkbox | Model | Required within parent | Expand Query a data source — request body — body filter value type checkbox checkbox |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3).number | Model | Required within parent | Expand Query a data source — request body — body filter value type number number |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4).date | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 1) (anyOf 1) | object | Alternative | |
$ (anyOf 1) (anyOf 1).contains | Model | Required within parent | Expand Query a data source — request body — body filter value type select select value equals equals |
$ (anyOf 1) (anyOf 2) | object | Alternative | |
$ (anyOf 1) (anyOf 2).does_not_contain | Model | Required within parent | Expand Query a data source — request body — body filter value type select select value equals equals |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 1) (anyOf 1) | object | Alternative | |
$ (anyOf 1) (anyOf 1).equals | number | Required within parent | |
$ (anyOf 1) (anyOf 2) | object | Alternative | |
$ (anyOf 1) (anyOf 2).does_not_equal | number | Required within parent | |
$ (anyOf 1) (anyOf 3) | object | Alternative | |
$ (anyOf 1) (anyOf 3).greater_than | number | Required within parent | |
$ (anyOf 1) (anyOf 4) | object | Alternative | |
$ (anyOf 1) (anyOf 4).less_than | number | Required within parent | |
$ (anyOf 1) (anyOf 5) | object | Alternative | |
$ (anyOf 1) (anyOf 5).greater_than_or_equal_to | number | Required within parent | |
$ (anyOf 1) (anyOf 6) | object | Alternative | |
$ (anyOf 1) (anyOf 6).less_than_or_equal_to | number | Required within parent | |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 1) (anyOf 1) | object | Alternative | |
$ (anyOf 1) (anyOf 1).contains | Model | Required within parent | Expand Query a data source — request body — body filter value type people people value contains contains |
$ (anyOf 1) (anyOf 2) | object | Alternative | |
$ (anyOf 1) (anyOf 2).does_not_contain | Model | Required within parent | Expand Query a data source — request body — body filter value type people people value contains contains |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | string | Alternative | Must equal: me |
Query a data source — request body — body filter value type relation relation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 1) (anyOf 1) | object | Alternative | |
$ (anyOf 1) (anyOf 1).contains | string | Required within parent | |
$ (anyOf 1) (anyOf 2) | object | Alternative | |
$ (anyOf 1) (anyOf 2).does_not_contain | string | Required within parent | |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1).any | Model | Required within parent | Expand Query a data source — request body — body filter value type rollup rollup any any |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2).none | Model | Required within parent | Expand Query a data source — request body — body filter value type rollup rollup any any |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3).every | Model | Required within parent | Expand Query a data source — request body — body filter value type rollup rollup any any |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4).date | Model | Required within parent | Expand Query a data source — request body — body filter value type date date |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5).number | Model | Required within parent | Expand 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 1) (anyOf 1) | object | Alternative | |
$ (anyOf 1) (anyOf 1).equals | Model | Required within parent | Expand Query a data source — request body — body filter value type select select value equals equals |
$ (anyOf 1) (anyOf 2) | object | Alternative | |
$ (anyOf 1) (anyOf 2).does_not_equal | Model | Required within parent | Expand Query a data source — request body — body filter value type select select value equals equals |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | array | Alternative | |
$ (anyOf 2)[] | string | Each item |
Query a data source — request body — body filter value type status status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Query a data source — request body — body filter value type status status value |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The group operators match status groups instead of options. They require the `Notion-Beta: status-group-filters-2026-10-06` header. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1).equals | Model | Required within parent | Expand Query a data source — request body — body filter value type select select value equals equals |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2).does_not_equal | Model | Required within parent | Expand Query a data source — request body — body filter value type select select value equals equals |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3).group_equals | Model | Required within parent | Expand Query a data source — request body — body filter value type status status value group equals group equals |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4).group_does_not_equal | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Maximum length: 100 Minimum length: 1 |
$ (anyOf 2) | array | Alternative | Maximum items: 100 Minimum items: 1 |
$ (anyOf 2)[] | string | Each item | Maximum length: 100 Minimum length: 1 |
Query a data source — request body — body filter value type url url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 1) (anyOf 1) | object | Alternative | |
$ (anyOf 1) (anyOf 1).equals | string | Required within parent | |
$ (anyOf 1) (anyOf 2) | object | Alternative | |
$ (anyOf 1) (anyOf 2).does_not_equal | string | Required within parent | |
$ (anyOf 1) (anyOf 3) | object | Alternative | |
$ (anyOf 1) (anyOf 3).contains | string | Required within parent | |
$ (anyOf 1) (anyOf 4) | object | Alternative | |
$ (anyOf 1) (anyOf 4).does_not_contain | string | Required within parent | |
$ (anyOf 1) (anyOf 5) | object | Alternative | |
$ (anyOf 1) (anyOf 5).starts_with | string | Required within parent | |
$ (anyOf 1) (anyOf 6) | object | Alternative | |
$ (anyOf 1) (anyOf 6).ends_with | string | Required within parent | |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Additional keys: not allowed |
$ (anyOf 1).property | string | Required within parent | |
$ (anyOf 1).title | Model | Required within parent | Expand Query a data source — request body — body filter value type url url |
$ (anyOf 1).type | string | Optional | Must equal: title |
$ (anyOf 2) | object | Alternative | Additional keys: not allowed |
$ (anyOf 2).property | string | Required within parent | |
$ (anyOf 2).rich_text | Model | Required within parent | Expand Query a data source — request body — body filter value type url url |
$ (anyOf 2).type | string | Optional | Must equal: rich_text |
$ (anyOf 3) | object | Alternative | Additional keys: not allowed |
$ (anyOf 3).number | Model | Required within parent | Expand Query a data source — request body — body filter value type number number |
$ (anyOf 3).property | string | Required within parent | |
$ (anyOf 3).type | string | Optional | Must equal: number |
$ (anyOf 4) | object | Alternative | Additional keys: not allowed |
$ (anyOf 4).checkbox | Model | Required within parent | Expand Query a data source — request body — body filter value type checkbox checkbox |
$ (anyOf 4).property | string | Required within parent | |
$ (anyOf 4).type | string | Optional | Must equal: checkbox |
$ (anyOf 5) | object | Alternative | Additional keys: not allowed |
$ (anyOf 5).property | string | Required within parent | |
$ (anyOf 5).select | Model | Required within parent | Expand Query a data source — request body — body filter value type select select |
$ (anyOf 5).type | string | Optional | Must equal: select |
$ (anyOf 6) | object | Alternative | Additional keys: not allowed |
$ (anyOf 6).multi_select | Model | Required within parent | Expand Query a data source — request body — body filter value type multi select multi select |
$ (anyOf 6).property | string | Required within parent | |
$ (anyOf 6).type | string | Optional | Must equal: multi_select |
$ (anyOf 7) | object | Alternative | Additional keys: not allowed |
$ (anyOf 7).property | string | Required within parent | |
$ (anyOf 7).status | Model | Required within parent | Expand Query a data source — request body — body filter value type status status |
$ (anyOf 7).type | string | Optional | Must equal: status |
$ (anyOf 8) | object | Alternative | Additional keys: not allowed |
$ (anyOf 8).date | Model | Required within parent | Expand Query a data source — request body — body filter value type date date |
$ (anyOf 8).property | string | Required within parent | |
$ (anyOf 8).type | string | Optional | Must equal: date |
$ (anyOf 9) | object | Alternative | Additional keys: not allowed |
$ (anyOf 9).people | Model | Required within parent | Expand Query a data source — request body — body filter value type people people |
$ (anyOf 9).property | string | Required within parent | |
$ (anyOf 9).type | string | Optional | Must equal: people |
$ (anyOf 10) | object | Alternative | Additional keys: not allowed |
$ (anyOf 10).files | Model | Required within parent | Expand Query a data source — request body — body filter value type files files |
$ (anyOf 10).property | string | Required within parent | |
$ (anyOf 10).type | string | Optional | Must equal: files |
$ (anyOf 11) | object | Alternative | Additional keys: not allowed |
$ (anyOf 11).property | string | Required within parent | |
$ (anyOf 11).type | string | Optional | Must equal: url |
$ (anyOf 11).url | Model | Required within parent | Expand Query a data source — request body — body filter value type url url |
$ (anyOf 12) | object | Alternative | Additional keys: not allowed |
$ (anyOf 12).email | Model | Required within parent | Expand Query a data source — request body — body filter value type url url |
$ (anyOf 12).property | string | Required within parent | |
$ (anyOf 12).type | string | Optional | Must equal: email |
$ (anyOf 13) | object | Alternative | Additional keys: not allowed |
$ (anyOf 13).phone_number | Model | Required within parent | Expand Query a data source — request body — body filter value type url url |
$ (anyOf 13).property | string | Required within parent | |
$ (anyOf 13).type | string | Optional | Must equal: phone_number |
$ (anyOf 14) | object | Alternative | Additional keys: not allowed |
$ (anyOf 14).property | string | Required within parent | |
$ (anyOf 14).relation | Model | Required within parent | Expand Query a data source — request body — body filter value type relation relation |
$ (anyOf 14).type | string | Optional | Must equal: relation |
$ (anyOf 15) | object | Alternative | Additional keys: not allowed |
$ (anyOf 15).created_by | Model | Required within parent | Expand Query a data source — request body — body filter value type people people |
$ (anyOf 15).property | string | Required within parent | |
$ (anyOf 15).type | string | Optional | Must equal: created_by |
$ (anyOf 16) | object | Alternative | Additional keys: not allowed |
$ (anyOf 16).created_time | Model | Required within parent | Expand Query a data source — request body — body filter value type date date |
$ (anyOf 16).property | string | Required within parent | |
$ (anyOf 16).type | string | Optional | Must equal: created_time |
$ (anyOf 17) | object | Alternative | Additional keys: not allowed |
$ (anyOf 17).last_edited_by | Model | Required within parent | Expand Query a data source — request body — body filter value type people people |
$ (anyOf 17).property | string | Required within parent | |
$ (anyOf 17).type | string | Optional | Must equal: last_edited_by |
$ (anyOf 18) | object | Alternative | Additional keys: not allowed |
$ (anyOf 18).last_edited_time | Model | Required within parent | Expand Query a data source — request body — body filter value type date date |
$ (anyOf 18).property | string | Required within parent | |
$ (anyOf 18).type | string | Optional | Must equal: last_edited_time |
$ (anyOf 19) | object | Alternative | Additional keys: not allowed |
$ (anyOf 19).formula | Model | Required within parent | Expand Query a data source — request body — body filter value type formula formula |
$ (anyOf 19).property | string | Required within parent | |
$ (anyOf 19).type | string | Optional | Must equal: formula |
$ (anyOf 20) | object | Alternative | Additional keys: not allowed |
$ (anyOf 20).property | string | Required within parent | |
$ (anyOf 20).type | string | Optional | Must equal: unique_id |
$ (anyOf 20).unique_id | Model | Required within parent | Expand Query a data source — request body — body filter value type number number |
$ (anyOf 21) | object | Alternative | Additional keys: not allowed |
$ (anyOf 21).property | string | Required within parent | |
$ (anyOf 21).rollup | Model | Required within parent | Expand Query a data source — request body — body filter value type rollup rollup |
$ (anyOf 21).type | string | Optional | Must equal: rollup |
$ (anyOf 22) | object | Alternative | Additional keys: not allowed |
$ (anyOf 22).property | string | Required within parent | |
$ (anyOf 22).type | string | Optional | Must equal: verification |
$ (anyOf 22).verification | JSON | Required within parent | |
$ (anyOf 22).verification (anyOf 1) | Model | Alternative | Expand Query a data source — request body — body / filter / value / type verification / verification / status: verified, expired, none |
$ (anyOf 22).verification (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Query a data source — request body — body filter value Created Time |
$ (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Sort by property name or ID, or by timestamp. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1).direction | string | Required within parent | One of: ascending, descending |
$ (anyOf 1).property | string | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2).direction | string | Required within parent | One of: ascending, descending |
$ (anyOf 2).timestamp | string | Required within parent | One of: created_time, last_edited_time |