Notion: Pages schemas (part 2)
82 Notion schemas with complete fields and constraints.
← Pages operations · All schemas
Retrieve a page property item — response body — value Title title annotations, href, plain text annotations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
bold | boolean | Required within parent | |
code | boolean | Required within parent | |
color | Model | Required within parent | Expand Delete a block — response body — value Quote quote color |
italic | boolean | Required within parent | |
strikethrough | boolean | Required within parent | |
underline | boolean | Required within parent |
Referenced models: Delete a block — response body — value Quote quote color
Retrieve a page property item — response body — value Title title value Equation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
equation | object | Required within parent | Notion supports inline LaTeX equations as rich text objects with a type value of `equation`. Additional keys: allowed |
equation.expression | string | Required within parent | A KaTeX compatible string. |
type | string | Required within parent | Always `equation` Must equal: equation |
Retrieve a page property item — response body — value Title title value Mention
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mention | JSON | Required within parent | Mention objects represent an inline mention of a database, date, link preview mention, page, template mention, or user. A mention is created in the Notion UI when a user types `@` followed by the name of the reference. |
mention (anyOf 1) | object | Alternative | Additional keys: allowed |
mention (anyOf 1).type | string | Required within parent | Always `user` Must equal: user |
mention (anyOf 1).user | Model | Required within parent | Expand Retrieve a page property item — response body — value Verification verification value Verified verified by value Details of the user mention. |
mention (anyOf 2) | object | Alternative | Additional keys: allowed |
mention (anyOf 2).date | Model | Required within parent | Expand Retrieve a page property item — response body — value Date date end, start, time zone Details of the date mention. |
mention (anyOf 2).type | string | Required within parent | Always `date` Must equal: date |
mention (anyOf 3) | object | Alternative | Additional keys: allowed |
mention (anyOf 3).link_preview | Model | Required within parent | Expand Retrieve a page property item — response body — value Title title value Mention mention type link preview link preview Details of the link preview mention. |
mention (anyOf 3).type | string | Required within parent | Always `link_preview` Must equal: link_preview |
mention (anyOf 4) | object | Alternative | Additional keys: allowed |
mention (anyOf 4).link_mention | Model | Required within parent | Expand Retrieve a page property item — response body — value Title title value Mention mention type link mention link mention Details of the link mention. |
mention (anyOf 4).type | string | Required within parent | Always `link_mention` Must equal: link_mention |
mention (anyOf 5) | object | Alternative | Additional keys: allowed |
mention (anyOf 5).page | object | Required within parent | Details of the page mention. Additional keys: allowed |
mention (anyOf 5).page.id | string | Required within parent | The ID of the page in the mention. Format: uuid |
mention (anyOf 5).type | string | Required within parent | Always `page` Must equal: page |
mention (anyOf 6) | object | Alternative | Additional keys: allowed |
mention (anyOf 6).database | object | Required within parent | Details of the database mention. Additional keys: allowed |
mention (anyOf 6).database.id | string | Required within parent | The ID of the database in the mention. Format: uuid |
mention (anyOf 6).type | string | Required within parent | Always `database` Must equal: database |
mention (anyOf 7) | object | Alternative | Additional keys: allowed |
mention (anyOf 7).template_mention | Model | Required within parent | Expand Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention Details of the template mention. |
mention (anyOf 7).type | string | Required within parent | Always `template_mention` Must equal: template_mention |
mention (anyOf 8) | object | Alternative | Additional keys: allowed |
mention (anyOf 8).custom_emoji | Model | Required within parent | Expand List custom emojis — response body — results item Details of the custom emoji mention. |
mention (anyOf 8).type | string | Required within parent | Always `custom_emoji` Must equal: custom_emoji |
type | string | Required within parent | Always `mention` Must equal: mention |
Referenced models: List custom emojis — response body — results item, Retrieve a page property item — response body — value Date date end, start, time zone, Retrieve a page property item — response body — value Title title value Mention mention type link mention link mention, Retrieve a page property item — response body — value Title title value Mention mention type link preview link preview, Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention, Retrieve a page property item — response body — value Verification verification value Verified verified by value
Retrieve a page property item — response body — value Title title value Mention mention type link mention link mention
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
description | string | Optional | The description of the link. |
height | JSON | Optional | |
height (anyOf 1) | integer | Alternative | The height of the link preview iframe. |
height (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
href | string | Required within parent | The href of the link mention. |
icon_url | string | Optional | The icon URL of the link. |
iframe_url | string | Optional | The iframe URL of the link. |
link_author | string | Optional | The author of the link. |
link_provider | string | Optional | The provider of the link. |
padding | JSON | Optional | |
padding (anyOf 1) | integer | Alternative | The padding of the link preview iframe. |
padding (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
padding_top | JSON | Optional | |
padding_top (anyOf 1) | integer | Alternative | The top padding of the link preview iframe. |
padding_top (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
thumbnail_url | string | Optional | The thumbnail URL of the link. |
title | string | Optional | The title of the link. |
Retrieve a page property item — response body — value Title title value Mention mention type link preview link preview
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
url | string | Required within parent | The URL of the link preview mention. |
Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention Template Mention Date |
$ (anyOf 2) | Model | Alternative | Expand Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention Template Mention User |
Referenced models: Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention Template Mention Date, Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention Template Mention User
Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention Template Mention Date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
template_mention_date | string | Required within parent | The date of the template mention. Known values: today, now |
type | string | Required within parent | Always `template_mention_date` Must equal: template_mention_date |
Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention Template Mention User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
template_mention_user | string | Required within parent | The user of the template mention. Must equal: me |
type | string | Required within parent | Always `template_mention_user` Must equal: template_mention_user |
Retrieve a page property item — response body — value Title title value Text
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
text | object | Required within parent | If a rich text object's type value is `text`, then the corresponding text field contains an object including the text content and any inline link. Additional keys: allowed |
text.content | string | Required within parent | The actual text content of the text. Maximum length: 2000 |
text.link | JSON | Required within parent | An object with information about any inline link in this text, if included. |
text.link (anyOf 1) | object | Alternative | Additional keys: allowed |
text.link (anyOf 1).url | string | Required within parent | The URL of the link. |
text.link (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `text` Must equal: text |
Retrieve a page property item — response body — value Unique Id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: unique_id |
unique_id | object | Required within parent | |
unique_id.number | JSON | Required within parent | |
unique_id.number (anyOf 1) | JSON | Alternative | |
unique_id.number (anyOf 1) (anyOf 1) | number | Alternative | |
unique_id.number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unique_id.number (anyOf 2) | null | Alternative | |
unique_id.prefix | JSON | Required within parent | |
unique_id.prefix (anyOf 1) | string | Alternative | |
unique_id.prefix (anyOf 2) | null | Alternative |
Retrieve a page property item — response body — value Url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: url |
url | JSON | Required within parent | |
url (anyOf 1) | string | Alternative | |
url (anyOf 2) | null | Alternative |
Retrieve a page property item — response body — value Verification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: verification |
verification | JSON | Required within parent | |
verification (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Verification verification value |
verification (anyOf 2) | null | Alternative |
Referenced models: Retrieve a page property item — response body — value Verification verification value
Retrieve a page property item — response body — value Verification verification value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Verification verification value Unverified |
$ (anyOf 2) | Model | Alternative | Expand Retrieve a page property item — response body — value Verification verification value Verified |
Referenced models: Retrieve a page property item — response body — value Verification verification value Verified, Retrieve a page property item — response body — value Verification verification value Unverified
Retrieve a page property item — response body — value Verification verification value Unverified
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
date | null | Required within parent | |
state | string | Required within parent | Always `unverified` Must equal: unverified |
verified_by | null | Required within parent |
Retrieve a page property item — response body — value Verification verification value Verified
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
date | JSON | Required within parent | |
date (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Date date end, start, time zone |
date (anyOf 2) | null | Alternative | |
state | string | Required within parent | One of: `verified`, `expired` Known values: verified, expired |
verified_by | JSON | Required within parent | |
verified_by (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Verification verification value Verified verified by value |
verified_by (anyOf 2) | null | Alternative |
Referenced models: Retrieve a page property item — response body — value Date date end, start, time zone, Retrieve a page property item — response body — value Verification verification value Verified verified by value
Retrieve a page property item — response body — value Verification verification value Verified verified by value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Update page — response body — object page created by |
$ (anyOf 2) | Model | Alternative | Expand Retrieve a user — response body |
Referenced models: Update page — response body — object page created by, Retrieve a user — response body
Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_e6202a2c2f72
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
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 (anyOf 1) | string | Alternative | Maximum length: 2000 Minimum length: 1 |
description (anyOf 2) | null | Alternative | |
id | string | Optional | Maximum length: 100 Minimum length: 1 |
name | string | Required within parent | Maximum length: 2000 Minimum length: 1 |
Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_ec4fbb25b089
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
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 (anyOf 1) | string | Alternative | Maximum length: 2000 Minimum length: 1 |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | Maximum length: 100 Minimum length: 1 |
name | string | Optional | Maximum length: 2000 Minimum length: 1 |
Update page — request body — body notifications
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Controls the notifications Notion sends people about this change. Set mode to "silent" to skip page update notifications, @mention notifications, and notifications to people added to a Person property, or "default" to use the standard behavior. Database automations, reminders, and connection webhooks still work as usual. Page history, page activity, and workspace audit logs still record the change. |
mode | string | Required within parent | One of: default, silent |
Update page — request body — body properties
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: see wildcard field |
$.* | JSON | Additional keys | |
$.* (anyOf 1) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 1).title | array | Required within parent | Maximum items: 100 |
$.* (anyOf 1).title[] | Model | Each item | Expand Create a database — request body — body title item |
$.* (anyOf 1).type | string | Optional | Must equal: title |
$.* (anyOf 2) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 2).rich_text | array | Required within parent | Maximum items: 100 |
$.* (anyOf 2).rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$.* (anyOf 2).type | string | Optional | Must equal: rich_text |
$.* (anyOf 3) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 3).number | number or null | Required within parent | |
$.* (anyOf 3).type | string | Optional | Must equal: number |
$.* (anyOf 4) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 4).type | string | Optional | Must equal: url |
$.* (anyOf 4).url | JSON | Required within parent | |
$.* (anyOf 4).url (anyOf 1) | string | Alternative | Maximum length: 2000 Minimum length: 1 |
$.* (anyOf 4).url (anyOf 2) | null | Alternative | |
$.* (anyOf 5) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 5).select | JSON | Required within parent | |
$.* (anyOf 5).select (anyOf 1) | Model | Alternative | Expand Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_ec4fbb25b089 |
$.* (anyOf 5).select (anyOf 2) | Model | Alternative | Expand Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_e6202a2c2f72 |
$.* (anyOf 5).select (anyOf 3) | null | Alternative | |
$.* (anyOf 5).type | string | Optional | Must equal: select |
$.* (anyOf 6) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 6).multi_select | array | Required within parent | Maximum items: 100 |
$.* (anyOf 6).multi_select[] | JSON | Each item | |
$.* (anyOf 6).multi_select[] (anyOf 1) | Model | Alternative | Expand Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_ec4fbb25b089 |
$.* (anyOf 6).multi_select[] (anyOf 2) | Model | Alternative | Expand Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_e6202a2c2f72 |
$.* (anyOf 6).type | string | Optional | Must equal: multi_select |
$.* (anyOf 7) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 7).people | array | Required within parent | Maximum items: 100 |
$.* (anyOf 7).people[] | JSON | Each item | |
$.* (anyOf 7).people[] (anyOf 1) | Model | Alternative | Expand Update page — request body — body properties value type people people item object user |
$.* (anyOf 7).people[] (anyOf 2) | Model | Alternative | Expand Update page — request body — body properties value type people people item object group |
$.* (anyOf 7).type | string | Optional | Must equal: people |
$.* (anyOf 8) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 8).email | JSON | Required within parent | |
$.* (anyOf 8).email (anyOf 1) | string | Alternative | Maximum length: 100 Minimum length: 1 |
$.* (anyOf 8).email (anyOf 2) | null | Alternative | |
$.* (anyOf 8).type | string | Optional | Must equal: email |
$.* (anyOf 9) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 9).phone_number | JSON | Required within parent | |
$.* (anyOf 9).phone_number (anyOf 1) | string | Alternative | Maximum length: 100 Minimum length: 1 |
$.* (anyOf 9).phone_number (anyOf 2) | null | Alternative | |
$.* (anyOf 9).type | string | Optional | Must equal: phone_number |
$.* (anyOf 10) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 10).date | JSON | Required within parent | |
$.* (anyOf 10).date (anyOf 1) | Model | Alternative | Expand Update page — request body — body properties value type date date end, start, time zone |
$.* (anyOf 10).date (anyOf 2) | null | Alternative | |
$.* (anyOf 10).type | string | Optional | Must equal: date |
$.* (anyOf 11) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 11).checkbox | boolean | Required within parent | |
$.* (anyOf 11).type | string | Optional | Must equal: checkbox |
$.* (anyOf 12) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 12).relation | array | Required within parent | Maximum items: 100 |
$.* (anyOf 12).relation[] | Model | Each item | Expand Update page — request body — body properties value type relation relation item |
$.* (anyOf 12).type | string | Optional | Must equal: relation |
$.* (anyOf 13) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 13).files | array | Required within parent | Maximum items: 100 |
$.* (anyOf 13).files[] | JSON | Each item | |
$.* (anyOf 13).files[] (anyOf 1) | Model | Alternative | Expand Update page — request body — body properties value type files files item value |
$.* (anyOf 13).files[] (anyOf 2) | Model | Alternative | Expand Update page — request body — body properties value type files files item type file upload |
$.* (anyOf 13).type | string | Optional | Must equal: files |
$.* (anyOf 14) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 14).status | JSON | Required within parent | |
$.* (anyOf 14).status (anyOf 1) | Model | Alternative | Expand Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_ec4fbb25b089 |
$.* (anyOf 14).status (anyOf 2) | Model | Alternative | Expand Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_e6202a2c2f72 |
$.* (anyOf 14).status (anyOf 3) | null | Alternative | |
$.* (anyOf 14).type | string | Optional | Must equal: status |
$.* (anyOf 15) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 15).place | object or null | Required within parent | |
$.* (anyOf 15).place.address | string or null | Optional | |
$.* (anyOf 15).place.aws_place_id | string or null | Optional | |
$.* (anyOf 15).place.google_place_id | string or null | Optional | |
$.* (anyOf 15).place.lat | number | Required within parent | |
$.* (anyOf 15).place.lon | number | Required within parent | |
$.* (anyOf 15).place.name | string or null | Optional | |
$.* (anyOf 15).type | string | Optional | Must equal: place |
$.* (anyOf 16) | object | Alternative | Additional keys: not allowed |
$.* (anyOf 16).type | string | Optional | Must equal: verification |
$.* (anyOf 16).verification | JSON | Required within parent | |
$.* (anyOf 16).verification (anyOf 1) | object | Alternative | |
$.* (anyOf 16).verification (anyOf 1).date | Model | Optional | Expand Update page — request body — body properties value type date date end, start, time zone |
$.* (anyOf 16).verification (anyOf 1).state | string | Required within parent | Must equal: verified |
$.* (anyOf 16).verification (anyOf 2) | object | Alternative | |
$.* (anyOf 16).verification (anyOf 2).state | string | Required within parent | Must equal: unverified |
Referenced models: Update page — request body — body properties value type relation relation item, Update page — request body — body properties value type date date end, start, time zone, Update page — request body — body properties value type files files item type file upload, Update page — request body — body properties value type people people item object group, Update page — request body — body properties value type files files item value, Update page — request body — body properties value type people people item object user, Create a database — request body — body title item, Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_e6202a2c2f72, Update page — request body — body / properties / value / type select / select / color: default, gray, brown, orange, yellow, green, blue, purple, pink, red — shared_select_ec4fbb25b089
Update page — request body — body properties value type date date end, start, time zone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
end | JSON | Optional | The end date of the date object, if any. |
end (anyOf 1) | string | Alternative | Format: date |
end (anyOf 2) | string | Alternative | Format: date-time Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])[Tt](?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:[Zz]|[+-](?:[01]\d|2[0-3]):[0-5]\d)$ |
end (anyOf 3) | string | Alternative | Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])T(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?$ |
end (anyOf 4) | null | Alternative | |
start | JSON | Required within parent | The start date of the date object. |
start (anyOf 1) | string | Alternative | Format: date |
start (anyOf 2) | string | Alternative | Format: date-time Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])[Tt](?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:[Zz]|[+-](?:[01]\d|2[0-3]):[0-5]\d)$ |
start (anyOf 3) | string | Alternative | Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])T(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?$ |
time_zone | JSON | Optional | The time zone of the date object, if any. E.g. America/Los_Angeles, Europe/London, etc. |
time_zone (oneOf 1) | string | Alternative | |
time_zone (oneOf 2) | null | Alternative |
Update page — request body — body properties value type files files item type file upload
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
file_upload | Model | Required within parent | Expand Update a block — request body — body value type pdf pdf file upload |
name | string | Optional | Maximum length: 100 Minimum length: 1 |
type | string | Optional | Must equal: file_upload |
Referenced models: Update a block — request body — body value type pdf pdf file upload
Update page — request body — body properties value type files files item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Additional keys: not allowed |
$ (anyOf 1).file | Model | Required within parent | Expand Update page — request body — body properties value type files files item value type file file |
$ (anyOf 1).name | string | Required within parent | Maximum length: 100 Minimum length: 1 |
$ (anyOf 1).type | string | Optional | Must equal: file |
$ (anyOf 2) | object | Alternative | Additional keys: not allowed |
$ (anyOf 2).external | Model | Required within parent | Expand Update a block — request body — body value type pdf pdf external |
$ (anyOf 2).name | string | Required within parent | Maximum length: 100 Minimum length: 1 |
$ (anyOf 2).type | string | Optional | Must equal: external |
Referenced models: Update a block — request body — body value type pdf pdf external, Update page — request body — body properties value type files files item value type file file
Update page — request body — body properties value type files files item value type file file
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
expiry_time | string | Optional | Format: date-time |
url | string | Required within parent |
Update page — request body — body properties value type people people item object group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
id | string | Required within parent | |
name | string or null | Optional | |
object | string | Optional | Must equal: group |
Update page — request body — body properties value type people people item object user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The ID of the user. |
object | string | Optional | The user object type name. Must equal: user |
Update page — request body — body properties value type relation relation item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent |
Update page — response body — object page cover value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Update page — response body — object page cover value File |
$ (anyOf 2) | Model | Alternative | Expand Update page — response body — object page cover value External |
Referenced models: Update page — response body — object page cover value External, Update page — response body — object page cover value File
Update page — response body — object page cover value External
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
external | object | Required within parent | The external URL for the cover. Additional keys: allowed |
external.url | string | Required within parent | The URL of the external file or resource. |
type | string | Required within parent | Type of cover. In this case, an external URL. Must equal: external |
Update page — response body — object page cover value File
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
file | Model | Required within parent | Expand Get agent — response body — icon value File file The file URL for the cover. |
type | string | Required within parent | Type of cover. In this case, a file. Must equal: file |
Referenced models: Get agent — response body — icon value File file
Update page — response body — object page created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | Format: uuid |
object | string | Required within parent | Always `user` Must equal: user |
Update page — response body — object page parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (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 |
$ (anyOf 3) | Model | Alternative | Expand Update page — response body — object page parent type page id |
$ (anyOf 4) | Model | Alternative | Expand Update page — response body — object page parent type block id |
$ (anyOf 5) | Model | Alternative | Expand Update page — response body — object page parent type agent id |
$ (anyOf 6) | Model | Alternative | Expand Update page — response body — object page parent type workspace, workspace True |
Referenced models: Update page — response body — object page parent type agent id, Update page — response body — object page parent type block id, Update page — response body — object page parent type data source id, Delete a view — response body — parent, Update page — response body — object page parent type page id, Update page — response body — object page parent type workspace, workspace True
Update page — response body — object page parent type agent id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
agent_id | string | Required within parent | The ID of the parent agent. Format: uuid |
type | string | Required within parent | The parent type. Must equal: agent_id |
Update page — response body — object page parent type block id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
block_id | string | Required within parent | The ID of the parent block. Format: uuid |
type | string | Required within parent | The parent type. Must equal: block_id |
Update page — response body — object page parent type data source id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
data_source_id | string | Required within parent | The ID of the parent data source. Format: uuid |
database_id | string | Required within parent | The ID of the data source's parent database. Format: uuid |
type | string | Required within parent | The parent type. Must equal: data_source_id |
Update page — response body — object page parent type page id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
page_id | string | Required within parent | The ID of the parent page. Format: uuid |
type | string | Required within parent | The parent type. Must equal: page_id |
Update page — response body — object page parent type workspace, workspace True
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
type | string | Required within parent | The parent type. Must equal: workspace |
workspace | boolean | Required within parent | Always true for workspace parent. Must equal: true |
Update page — response body — object page properties value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Update page — response body — object page properties value id |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2) (anyOf 1) | Model | Alternative | Expand Update page — response body — object page properties value value value |
$ (allOf 2) (anyOf 2) | Model | Alternative | Expand Update page — response body — object page properties value value type rollup |
Referenced models: Update page — response body — object page properties value id, Update page — response body — object page properties value value type rollup, Update page — response body — object page properties value value value
Update page — response body — object page properties value id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent |
Update page — response body — object page properties value value type rollup
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
rollup | Model | Required within parent | Expand Update page — response body — object page properties value value type rollup rollup |
type | string | Required within parent | Always `rollup` Must equal: rollup |
Referenced models: Update page — response body — object page properties value value type rollup rollup
Update page — response body — object page properties value value type rollup rollup
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Update page — response body — object page properties value value type rollup rollup function |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2) (anyOf 1) | Model | Alternative | Expand Update page — response body — object page properties value value type rollup rollup value Number |
$ (allOf 2) (anyOf 2) | Model | Alternative | Expand Update page — response body — object page properties value value type rollup rollup value Date |
$ (allOf 2) (anyOf 3) | Model | Alternative | Expand Update page — response body — object page properties value value type rollup rollup value Array |
$ (allOf 2) (anyOf 4) | Model | Alternative | Expand Update page — response body — object page properties value value type rollup rollup value Unsupported |
Referenced models: Update page — response body — object page properties value value type rollup rollup value Array, Update page — response body — object page properties value value type rollup rollup value Date, Update page — response body — object page properties value value type rollup rollup value Number, Update page — response body — object page properties value value type rollup rollup function, Update page — response body — object page properties value value type rollup rollup value Unsupported
Update page — response body — object page properties value value type rollup rollup function
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
function | string | Required within parent | The function used 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 |
Update page — response body — object page properties value value type rollup rollup value Array
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
array | array | Required within parent | Maximum items: 100 |
array[] | Model | Each item | Expand Update page — response body — object page properties value value value |
type | string | Required within parent | Always `array` Must equal: array |
Referenced models: Update page — response body — object page properties value value value
Update page — response body — object page properties value value type rollup rollup value Date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | JSON | Required within parent | |
date (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Date date end, start, time zone |
date (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `date` Must equal: date |
Referenced models: Retrieve a page property item — response body — value Date date end, start, time zone
Update page — response body — object page properties value value type rollup rollup value Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
number | JSON | Required within parent | |
number (anyOf 1) | JSON | Alternative | |
number (anyOf 1) (anyOf 1) | number | Alternative | |
number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `number` Must equal: number |
Update page — response body — object page properties value value type rollup rollup value Unsupported
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Always `unsupported` Must equal: unsupported |
unsupported | Model | Required within parent | Expand List views — response body — view |
Referenced models: List views — response body — view
Update page — response body — object page properties value value value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Update page — response body — object page properties value value value value — simple Property Value Response |
$ (anyOf 2) | Model | Alternative | Expand Update page — response body — object page properties value value value value — array Based Property Value Response |
Referenced models: Update page — response body — object page properties value value value value — array Based Property Value Response, Update page — response body — object page properties value value value value — simple Property Value Response
Update page — response body — object page properties value value value value Button
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
button | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Always `button` Must equal: button |
Referenced models: List views — response body — view
Update page — response body — object page properties value value value value Checkbox
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
checkbox | boolean | Required within parent | |
type | string | Required within parent | Always `checkbox` Must equal: checkbox |
Update page — response body — object page properties value value value value Created By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
created_by | Model | Required within parent | Expand Retrieve a page property item — response body — value Verification verification value Verified verified by value |
type | string | Required within parent | Always `created_by` Must equal: created_by |
Referenced models: Retrieve a page property item — response body — value Verification verification value Verified verified by value
Update page — response body — object page properties value value value value Created Time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
created_time | string | Required within parent | Format: date-time |
type | string | Required within parent | Always `created_time` Must equal: created_time |
Update page — response body — object page properties value value value value Date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
date | JSON | Required within parent | |
date (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Date date end, start, time zone |
date (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `date` Must equal: date |
Referenced models: Retrieve a page property item — response body — value Date date end, start, time zone
Update page — response body — object page properties value value value value Email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `email` Must equal: email |
Update page — response body — object page properties value value value value Files
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
files | array | Required within parent | Maximum items: 100 |
files[] | Model | Each item | Expand Retrieve a page property item — response body — value Files files item |
type | string | Required within parent | Always `files` Must equal: files |
Referenced models: Retrieve a page property item — response body — value Files files item
Update page — response body — object page properties value value value value Formula
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
formula | Model | Required within parent | Expand Update page — response body — object page properties value value value value Formula formula |
type | string | Required within parent | Always `formula` Must equal: formula |
Referenced models: Update page — response body — object page properties value value value value Formula formula
Update page — response body — object page properties value value value value Formula formula
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Update page — response body — object page properties value value value value Formula formula Boolean |
$ (anyOf 2) | Model | Alternative | Expand Update page — response body — object page properties value value value value Date |
$ (anyOf 3) | Model | Alternative | Expand Update page — response body — object page properties value value value value Number |
$ (anyOf 4) | Model | Alternative | Expand Update page — response body — object page properties value value value value Formula formula String |
$ (anyOf 5) | Model | Alternative | Expand Update page — response body — object page properties value value value value Formula formula Unsupported |
Referenced models: Update page — response body — object page properties value value value value Formula formula Boolean, Update page — response body — object page properties value value value value Date, Update page — response body — object page properties value value value value Number, Update page — response body — object page properties value value value value Formula formula String, Update page — response body — object page properties value value value value Formula formula Unsupported
Update page — response body — object page properties value value value value Formula formula Boolean
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
boolean | JSON | Required within parent | |
boolean (anyOf 1) | boolean | Alternative | |
boolean (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `boolean` Must equal: boolean |
Update page — response body — object page properties value value value value Formula formula String
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
string | JSON | Required within parent | |
string (anyOf 1) | string | Alternative | |
string (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `string` Must equal: string |
Update page — response body — object page properties value value value value Formula formula Unsupported
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
type | string | Required within parent | Always `unsupported` Must equal: unsupported |
unsupported | Model | Required within parent | Expand List views — response body — view |
Referenced models: List views — response body — view
Update page — response body — object page properties value value value value Last Edited By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
last_edited_by | Model | Required within parent | Expand Retrieve a page property item — response body — value Verification verification value Verified verified by value |
type | string | Required within parent | Always `last_edited_by` Must equal: last_edited_by |
Referenced models: Retrieve a page property item — response body — value Verification verification value Verified verified by value
Update page — response body — object page properties value value value value Last Edited Time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
last_edited_time | string | Required within parent | Format: date-time |
type | string | Required within parent | Always `last_edited_time` Must equal: last_edited_time |
Update page — response body — object page properties value value value value Multi Select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
multi_select | array | Required within parent | Maximum items: 100 |
multi_select[] | Model | Each item | Expand Update page — response body — object page properties value value value value Multi Select multi select item |
type | string | Required within parent | Always `multi_select` Must equal: multi_select |
Referenced models: Update page — response body — object page properties value value value value Multi Select multi select item
Update page — response body — object page properties value value value value Multi Select multi select 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 |
id | string | Required within parent | |
name | string | Required within parent |
Update page — response body — object page properties value value value value Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
number | JSON | Required within parent | |
number (anyOf 1) | JSON | Alternative | |
number (anyOf 1) (anyOf 1) | number | Alternative | |
number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `number` Must equal: number |
Update page — response body — object page properties value value value value People
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
people | array | Required within parent | Maximum items: 100 |
people[] | JSON | Each item | |
people[] (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Verification verification value Verified verified by value |
people[] (anyOf 2) | Model | Alternative | Expand Update page — response body — object page properties value value value value People people item object group |
type | string | Required within parent | Always `people` Must equal: people |
Referenced models: Update page — response body — object page properties value value value value People people item object group, Retrieve a page property item — response body — value Verification verification value Verified verified by value
Update page — response body — object page properties value value value value People people item object group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of the group. Format: uuid |
name | JSON | Required within parent | The name of the group. |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
object | string | Required within parent | The group object type name. Must equal: group |
Update page — response body — object page properties value value value value Phone Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | |
phone_number (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `phone_number` Must equal: phone_number |
Update page — response body — object page properties value value value value Place
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
place | JSON | Required within parent | |
place (anyOf 1) | Model | Alternative | Expand Update page — response body — object page properties value value value value Place place address, aws place id, google place id, lat, lon, name |
place (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `place` Must equal: place |
Referenced models: Update page — response body — object page properties value value value value Place place address, aws place id, google place id, lat, lon, name
Update page — response body — object page properties value value value value Place place address, aws place id, google place id, lat, lon, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
address | JSON | Optional | |
address (anyOf 1) | string | Alternative | |
address (anyOf 2) | null | Alternative | |
aws_place_id | JSON | Optional | |
aws_place_id (anyOf 1) | string | Alternative | |
aws_place_id (anyOf 2) | null | Alternative | |
google_place_id | JSON | Optional | |
google_place_id (anyOf 1) | string | Alternative | |
google_place_id (anyOf 2) | null | Alternative | |
lat | JSON | Required within parent | |
lat (anyOf 1) | number | Alternative | |
lat (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
lon | JSON | Required within parent | |
lon (anyOf 1) | number | Alternative | |
lon (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
Update page — response body — object page properties value value value value Relation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
relation | array | Required within parent | Maximum items: 100 |
relation[] | Model | Each item | Expand Update page — request body — body properties value type relation relation item |
type | string | Required within parent | Always `relation` Must equal: relation |
Referenced models: Update page — request body — body properties value type relation relation item
Update page — response body — object page properties value value value value Rich Text
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
type | string | Required within parent | Always `rich_text` Must equal: rich_text |
Referenced models: Retrieve a page property item — response body — value Title title
Update page — response body — object page properties value value value value Select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
select | JSON | Required within parent | |
select (anyOf 1) | Model | Alternative | Expand Update page — response body — object page properties value value value value Multi Select multi select item |
select (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `select` Must equal: select |
Referenced models: Update page — response body — object page properties value value value value Multi Select multi select item
Update page — response body — object page properties value value value value Status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
status | JSON | Required within parent | |
status (anyOf 1) | Model | Alternative | Expand Update page — response body — object page properties value value value value Multi Select multi select item |
status (anyOf 2) | null | Alternative | |
type | string | Required within parent | Always `status` Must equal: status |
Referenced models: Update page — response body — object page properties value value value value Multi Select multi select item
Update page — response body — object page properties value value value value Title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
title | array | Required within parent | Maximum items: 100 |
title[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
type | string | Required within parent | Always `title` Must equal: title |
Referenced models: Retrieve a page property item — response body — value Title title
Update page — response body — object page properties value value value value Unique Id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
type | string | Required within parent | Always `unique_id` Must equal: unique_id |
unique_id | Model | Required within parent | Expand Update page — response body — object page properties value value value value Unique Id unique id |
Referenced models: Update page — response body — object page properties value value value value Unique Id unique id
Update page — response body — object page properties value value value value Unique Id unique id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
number | JSON | Required within parent | |
number (anyOf 1) | JSON | Alternative | |
number (anyOf 1) (anyOf 1) | number | Alternative | |
number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number (anyOf 2) | null | Alternative | |
prefix | JSON | Required within parent | |
prefix (anyOf 1) | string | Alternative | |
prefix (anyOf 2) | null | Alternative |
Update page — response body — object page properties value value value value Url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
type | string | Required within parent | Always `url` Must equal: url |
url | JSON | Required within parent | |
url (anyOf 1) | string | Alternative | |
url (anyOf 2) | null | Alternative |
Update page — response body — object page properties value value value value Verification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
type | string | Required within parent | Always `verification` Must equal: verification |
verification | JSON | Required within parent | |
verification (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Verification verification value |
verification (anyOf 2) | null | Alternative |
Referenced models: Retrieve a page property item — response body — value Verification verification value
Update page — response body — object page properties value value value value — array Based Property Value Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Update page — response body — object page properties value value value value Title |
$ (anyOf 2) | Model | Alternative | Expand Update page — response body — object page properties value value value value Rich Text |
$ (anyOf 3) | Model | Alternative | Expand Update page — response body — object page properties value value value value People |
$ (anyOf 4) | Model | Alternative | Expand Update page — response body — object page properties value value value value Relation |
Referenced models: Update page — response body — object page properties value value value value People, Update page — response body — object page properties value value value value Relation, Update page — response body — object page properties value value value value Rich Text, Update page — response body — object page properties value value value value Title
Update page — response body — object page properties value value value value — simple Property Value Response
Referenced models: Update page — response body — object page properties value value value value Button, Update page — response body — object page properties value value value value Checkbox, Update page — response body — object page properties value value value value Created By, Update page — response body — object page properties value value value value Created Time, Update page — response body — object page properties value value value value Date, Update page — response body — object page properties value value value value Email, Update page — response body — object page properties value value value value Files, Update page — response body — object page properties value value value value Formula, Update page — response body — object page properties value value value value Last Edited By, Update page — response body — object page properties value value value value Last Edited Time, Update page — response body — object page properties value value value value Multi Select, Update page — response body — object page properties value value value value Number, Update page — response body — object page properties value value value value Phone Number, Update page — response body — object page properties value value value value Place, Update page — response body — object page properties value value value value Select, Update page — response body — object page properties value value value value Status, Update page — response body — object page properties value value value value Unique Id, Update page — response body — object page properties value value value value Url, Update page — response body — object page properties value value value value Verification
Update page — response body — object page — page Object Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
cover | JSON | Required within parent | Page cover image. |
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 User who created the page. |
created_time | string | Required within parent | Date and time when this page was created. Format: date-time |
icon | JSON | Required within parent | Page icon. |
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 page. Format: uuid |
in_trash | boolean | Required within parent | Whether the page is in trash. |
is_archived | boolean | Required within parent | Whether the page has been archived. |
is_locked | boolean | Required within parent | Whether the page is locked from editing in the Notion app UI. |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by User who last edited the page. |
last_edited_time | string | Required within parent | Date and time when this page was last edited. Format: date-time |
object | string | Required within parent | The page object type name. Must equal: page |
parent | Model | Required within parent | Expand Update page — response body — object page parent Information about the page's parent. |
properties | object | Required within parent | Property values of this page. Additional keys: see wildcard field |
properties.* | Model | Additional keys | Expand Update page — response body — object page properties value |
public_url | JSON | Required within parent | The public URL of the Notion page, if it has been published to the web. |
public_url (anyOf 1) | string | Alternative | |
public_url (anyOf 2) | null | Alternative | |
url | string | Required within parent | The URL of the Notion page. |
Referenced models: Update page — response body — object page cover value, Get agent — response body — icon value, Update page — response body — object page properties value, Update page — response body — object page parent, Update page — response body — object page created by
Update page — response body — object page — partial Page Object Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of the page. Format: uuid |
object | string | Required within parent | The page object type name. Must equal: page |