Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
boldbooleanRequired within parent
codebooleanRequired within parent
colorModelRequired within parentExpand Delete a block — response body — value Quote quote color
italicbooleanRequired within parent
strikethroughbooleanRequired within parent
underlinebooleanRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
equationobjectRequired within parentNotion supports inline LaTeX equations as rich text objects with a type value of `equation`.
Additional keys: allowed
equation.expressionstringRequired within parentA KaTeX compatible string.
typestringRequired within parentAlways `equation`
Must equal: equation

Retrieve a page property item — response body — value Title title value Mention

FieldTypePresenceDescription and constraints
$objectRoot
mentionJSONRequired within parentMention 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)objectAlternativeAdditional keys: allowed
mention (anyOf 1).typestringRequired within parentAlways `user`
Must equal: user
mention (anyOf 1).userModelRequired within parentExpand Retrieve a page property item — response body — value Verification verification value Verified verified by value
Details of the user mention.
mention (anyOf 2)objectAlternativeAdditional keys: allowed
mention (anyOf 2).dateModelRequired within parentExpand Retrieve a page property item — response body — value Date date end, start, time zone
Details of the date mention.
mention (anyOf 2).typestringRequired within parentAlways `date`
Must equal: date
mention (anyOf 3)objectAlternativeAdditional keys: allowed
mention (anyOf 3).link_previewModelRequired within parentExpand 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).typestringRequired within parentAlways `link_preview`
Must equal: link_preview
mention (anyOf 4)objectAlternativeAdditional keys: allowed
mention (anyOf 4).link_mentionModelRequired within parentExpand 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).typestringRequired within parentAlways `link_mention`
Must equal: link_mention
mention (anyOf 5)objectAlternativeAdditional keys: allowed
mention (anyOf 5).pageobjectRequired within parentDetails of the page mention.
Additional keys: allowed
mention (anyOf 5).page.idstringRequired within parentThe ID of the page in the mention.
Format: uuid
mention (anyOf 5).typestringRequired within parentAlways `page`
Must equal: page
mention (anyOf 6)objectAlternativeAdditional keys: allowed
mention (anyOf 6).databaseobjectRequired within parentDetails of the database mention.
Additional keys: allowed
mention (anyOf 6).database.idstringRequired within parentThe ID of the database in the mention.
Format: uuid
mention (anyOf 6).typestringRequired within parentAlways `database`
Must equal: database
mention (anyOf 7)objectAlternativeAdditional keys: allowed
mention (anyOf 7).template_mentionModelRequired within parentExpand 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).typestringRequired within parentAlways `template_mention`
Must equal: template_mention
mention (anyOf 8)objectAlternativeAdditional keys: allowed
mention (anyOf 8).custom_emojiModelRequired within parentExpand List custom emojis — response body — results item
Details of the custom emoji mention.
mention (anyOf 8).typestringRequired within parentAlways `custom_emoji`
Must equal: custom_emoji
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
descriptionstringOptionalThe description of the link.
heightJSONOptional
height (anyOf 1)integerAlternativeThe height of the link preview iframe.
height (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hrefstringRequired within parentThe href of the link mention.
icon_urlstringOptionalThe icon URL of the link.
iframe_urlstringOptionalThe iframe URL of the link.
link_authorstringOptionalThe author of the link.
link_providerstringOptionalThe provider of the link.
paddingJSONOptional
padding (anyOf 1)integerAlternativeThe padding of the link preview iframe.
padding (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
padding_topJSONOptional
padding_top (anyOf 1)integerAlternativeThe top padding of the link preview iframe.
padding_top (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
thumbnail_urlstringOptionalThe thumbnail URL of the link.
titlestringOptionalThe title of the link.

Retrieve a page property item — response body — value Title title value Mention mention type link preview link preview

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
urlstringRequired within parentThe URL of the link preview mention.

Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Title title value Mention mention type template mention template mention Template Mention Date
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
template_mention_datestringRequired within parentThe date of the template mention.
Known values: today, now
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
template_mention_userstringRequired within parentThe user of the template mention.
Must equal: me
typestringRequired within parentAlways `template_mention_user`
Must equal: template_mention_user

Retrieve a page property item — response body — value Title title value Text

FieldTypePresenceDescription and constraints
$objectRoot
textobjectRequired within parentIf 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.contentstringRequired within parentThe actual text content of the text.
Maximum length: 2000
text.linkJSONRequired within parentAn object with information about any inline link in this text, if included.
text.link (anyOf 1)objectAlternativeAdditional keys: allowed
text.link (anyOf 1).urlstringRequired within parentThe URL of the link.
text.link (anyOf 2)nullAlternative
typestringRequired within parentAlways `text`
Must equal: text

Retrieve a page property item — response body — value Unique Id

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: unique_id
unique_idobjectRequired within parent
unique_id.numberJSONRequired within parent
unique_id.number (anyOf 1)JSONAlternative
unique_id.number (anyOf 1) (anyOf 1)numberAlternative
unique_id.number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unique_id.number (anyOf 2)nullAlternative
unique_id.prefixJSONRequired within parent
unique_id.prefix (anyOf 1)stringAlternative
unique_id.prefix (anyOf 2)nullAlternative

Retrieve a page property item — response body — value Url

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: url
urlJSONRequired within parent
url (anyOf 1)stringAlternative
url (anyOf 2)nullAlternative

Retrieve a page property item — response body — value Verification

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: verification
verificationJSONRequired within parent
verification (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Verification verification value
verification (anyOf 2)nullAlternative

Referenced models: Retrieve a page property item — response body — value Verification verification value

Retrieve a page property item — response body — value Verification verification value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Verification verification value Unverified
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
datenullRequired within parent
statestringRequired within parentAlways `unverified`
Must equal: unverified
verified_bynullRequired within parent

Retrieve a page property item — response body — value Verification verification value Verified

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
dateJSONRequired within parent
date (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Date date end, start, time zone
date (anyOf 2)nullAlternative
statestringRequired within parentOne of: `verified`, `expired`
Known values: verified, expired
verified_byJSONRequired within parent
verified_by (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Verification verification value Verified verified by value
verified_by (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update page — response body — object page created by
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
colorstringOptionalOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
One of: default, gray, brown, orange, yellow, green, blue, purple, pink, red
descriptionJSONOptional
description (anyOf 1)stringAlternativeMaximum length: 2000
Minimum length: 1
description (anyOf 2)nullAlternative
idstringOptionalMaximum length: 100
Minimum length: 1
namestringRequired within parentMaximum 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
colorstringOptionalOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
One of: default, gray, brown, orange, yellow, green, blue, purple, pink, red
descriptionJSONOptional
description (anyOf 1)stringAlternativeMaximum length: 2000
Minimum length: 1
description (anyOf 2)nullAlternative
idstringRequired within parentMaximum length: 100
Minimum length: 1
namestringOptionalMaximum length: 2000
Minimum length: 1

Update page — request body — body notifications

FieldTypePresenceDescription and constraints
$objectRootControls 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.
modestringRequired within parentOne of: default, silent

Update page — request body — body properties

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: see wildcard field
$.*JSONAdditional keys
$.* (anyOf 1)objectAlternativeAdditional keys: not allowed
$.* (anyOf 1).titlearrayRequired within parentMaximum items: 100
$.* (anyOf 1).title[]ModelEach itemExpand Create a database — request body — body title item
$.* (anyOf 1).typestringOptionalMust equal: title
$.* (anyOf 2)objectAlternativeAdditional keys: not allowed
$.* (anyOf 2).rich_textarrayRequired within parentMaximum items: 100
$.* (anyOf 2).rich_text[]ModelEach itemExpand Create a database — request body — body title item
$.* (anyOf 2).typestringOptionalMust equal: rich_text
$.* (anyOf 3)objectAlternativeAdditional keys: not allowed
$.* (anyOf 3).numbernumber or nullRequired within parent
$.* (anyOf 3).typestringOptionalMust equal: number
$.* (anyOf 4)objectAlternativeAdditional keys: not allowed
$.* (anyOf 4).typestringOptionalMust equal: url
$.* (anyOf 4).urlJSONRequired within parent
$.* (anyOf 4).url (anyOf 1)stringAlternativeMaximum length: 2000
Minimum length: 1
$.* (anyOf 4).url (anyOf 2)nullAlternative
$.* (anyOf 5)objectAlternativeAdditional keys: not allowed
$.* (anyOf 5).selectJSONRequired within parent
$.* (anyOf 5).select (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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)nullAlternative
$.* (anyOf 5).typestringOptionalMust equal: select
$.* (anyOf 6)objectAlternativeAdditional keys: not allowed
$.* (anyOf 6).multi_selectarrayRequired within parentMaximum items: 100
$.* (anyOf 6).multi_select[]JSONEach item
$.* (anyOf 6).multi_select[] (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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).typestringOptionalMust equal: multi_select
$.* (anyOf 7)objectAlternativeAdditional keys: not allowed
$.* (anyOf 7).peoplearrayRequired within parentMaximum items: 100
$.* (anyOf 7).people[]JSONEach item
$.* (anyOf 7).people[] (anyOf 1)ModelAlternativeExpand Update page — request body — body properties value type people people item object user
$.* (anyOf 7).people[] (anyOf 2)ModelAlternativeExpand Update page — request body — body properties value type people people item object group
$.* (anyOf 7).typestringOptionalMust equal: people
$.* (anyOf 8)objectAlternativeAdditional keys: not allowed
$.* (anyOf 8).emailJSONRequired within parent
$.* (anyOf 8).email (anyOf 1)stringAlternativeMaximum length: 100
Minimum length: 1
$.* (anyOf 8).email (anyOf 2)nullAlternative
$.* (anyOf 8).typestringOptionalMust equal: email
$.* (anyOf 9)objectAlternativeAdditional keys: not allowed
$.* (anyOf 9).phone_numberJSONRequired within parent
$.* (anyOf 9).phone_number (anyOf 1)stringAlternativeMaximum length: 100
Minimum length: 1
$.* (anyOf 9).phone_number (anyOf 2)nullAlternative
$.* (anyOf 9).typestringOptionalMust equal: phone_number
$.* (anyOf 10)objectAlternativeAdditional keys: not allowed
$.* (anyOf 10).dateJSONRequired within parent
$.* (anyOf 10).date (anyOf 1)ModelAlternativeExpand Update page — request body — body properties value type date date end, start, time zone
$.* (anyOf 10).date (anyOf 2)nullAlternative
$.* (anyOf 10).typestringOptionalMust equal: date
$.* (anyOf 11)objectAlternativeAdditional keys: not allowed
$.* (anyOf 11).checkboxbooleanRequired within parent
$.* (anyOf 11).typestringOptionalMust equal: checkbox
$.* (anyOf 12)objectAlternativeAdditional keys: not allowed
$.* (anyOf 12).relationarrayRequired within parentMaximum items: 100
$.* (anyOf 12).relation[]ModelEach itemExpand Update page — request body — body properties value type relation relation item
$.* (anyOf 12).typestringOptionalMust equal: relation
$.* (anyOf 13)objectAlternativeAdditional keys: not allowed
$.* (anyOf 13).filesarrayRequired within parentMaximum items: 100
$.* (anyOf 13).files[]JSONEach item
$.* (anyOf 13).files[] (anyOf 1)ModelAlternativeExpand Update page — request body — body properties value type files files item value
$.* (anyOf 13).files[] (anyOf 2)ModelAlternativeExpand Update page — request body — body properties value type files files item type file upload
$.* (anyOf 13).typestringOptionalMust equal: files
$.* (anyOf 14)objectAlternativeAdditional keys: not allowed
$.* (anyOf 14).statusJSONRequired within parent
$.* (anyOf 14).status (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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)nullAlternative
$.* (anyOf 14).typestringOptionalMust equal: status
$.* (anyOf 15)objectAlternativeAdditional keys: not allowed
$.* (anyOf 15).placeobject or nullRequired within parent
$.* (anyOf 15).place.addressstring or nullOptional
$.* (anyOf 15).place.aws_place_idstring or nullOptional
$.* (anyOf 15).place.google_place_idstring or nullOptional
$.* (anyOf 15).place.latnumberRequired within parent
$.* (anyOf 15).place.lonnumberRequired within parent
$.* (anyOf 15).place.namestring or nullOptional
$.* (anyOf 15).typestringOptionalMust equal: place
$.* (anyOf 16)objectAlternativeAdditional keys: not allowed
$.* (anyOf 16).typestringOptionalMust equal: verification
$.* (anyOf 16).verificationJSONRequired within parent
$.* (anyOf 16).verification (anyOf 1)objectAlternative
$.* (anyOf 16).verification (anyOf 1).dateModelOptionalExpand Update page — request body — body properties value type date date end, start, time zone
$.* (anyOf 16).verification (anyOf 1).statestringRequired within parentMust equal: verified
$.* (anyOf 16).verification (anyOf 2)objectAlternative
$.* (anyOf 16).verification (anyOf 2).statestringRequired within parentMust 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
endJSONOptionalThe end date of the date object, if any.
end (anyOf 1)stringAlternativeFormat: date
end (anyOf 2)stringAlternativeFormat: 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)stringAlternativePattern: ^\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)nullAlternative
startJSONRequired within parentThe start date of the date object.
start (anyOf 1)stringAlternativeFormat: date
start (anyOf 2)stringAlternativeFormat: 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)stringAlternativePattern: ^\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_zoneJSONOptionalThe time zone of the date object, if any. E.g. America/Los_Angeles, Europe/London, etc.
time_zone (oneOf 1)stringAlternative
time_zone (oneOf 2)nullAlternative

Update page — request body — body properties value type files files item type file upload

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
file_uploadModelRequired within parentExpand Update a block — request body — body value type pdf pdf file upload
namestringOptionalMaximum length: 100
Minimum length: 1
typestringOptionalMust 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeAdditional keys: not allowed
$ (anyOf 1).fileModelRequired within parentExpand Update page — request body — body properties value type files files item value type file file
$ (anyOf 1).namestringRequired within parentMaximum length: 100
Minimum length: 1
$ (anyOf 1).typestringOptionalMust equal: file
$ (anyOf 2)objectAlternativeAdditional keys: not allowed
$ (anyOf 2).externalModelRequired within parentExpand Update a block — request body — body value type pdf pdf external
$ (anyOf 2).namestringRequired within parentMaximum length: 100
Minimum length: 1
$ (anyOf 2).typestringOptionalMust 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
expiry_timestringOptionalFormat: date-time
urlstringRequired within parent

Update page — request body — body properties value type people people item object group

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
idstringRequired within parent
namestring or nullOptional
objectstringOptionalMust equal: group

Update page — request body — body properties value type people people item object user

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe ID of the user.
objectstringOptionalThe user object type name.
Must equal: user

Update page — request body — body properties value type relation relation item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent

Update page — response body — object page cover value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update page — response body — object page cover value File
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
externalobjectRequired within parentThe external URL for the cover.
Additional keys: allowed
external.urlstringRequired within parentThe URL of the external file or resource.
typestringRequired within parentType of cover. In this case, an external URL.
Must equal: external

Update page — response body — object page cover value File

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
fileModelRequired within parentExpand Get agent — response body — icon value File file
The file URL for the cover.
typestringRequired within parentType 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentFormat: uuid
objectstringRequired within parentAlways `user`
Must equal: user

Update page — response body — object page parent

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Delete a view — response body — parent
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page parent type data source id
$ (anyOf 3)ModelAlternativeExpand Update page — response body — object page parent type page id
$ (anyOf 4)ModelAlternativeExpand Update page — response body — object page parent type block id
$ (anyOf 5)ModelAlternativeExpand Update page — response body — object page parent type agent id
$ (anyOf 6)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
agent_idstringRequired within parentThe ID of the parent agent.
Format: uuid
typestringRequired within parentThe parent type.
Must equal: agent_id

Update page — response body — object page parent type block id

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
block_idstringRequired within parentThe ID of the parent block.
Format: uuid
typestringRequired within parentThe parent type.
Must equal: block_id

Update page — response body — object page parent type data source id

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
data_source_idstringRequired within parentThe ID of the parent data source.
Format: uuid
database_idstringRequired within parentThe ID of the data source's parent database.
Format: uuid
typestringRequired within parentThe parent type.
Must equal: data_source_id

Update page — response body — object page parent type page id

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
page_idstringRequired within parentThe ID of the parent page.
Format: uuid
typestringRequired within parentThe parent type.
Must equal: page_id

Update page — response body — object page parent type workspace, workspace True

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
typestringRequired within parentThe parent type.
Must equal: workspace
workspacebooleanRequired within parentAlways true for workspace parent.
Must equal: true

Update page — response body — object page properties value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update page — response body — object page properties value id
$ (allOf 2)JSONAll variants apply
$ (allOf 2) (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value value
$ (allOf 2) (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent

Update page — response body — object page properties value value type rollup

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
rollupModelRequired within parentExpand Update page — response body — object page properties value value type rollup rollup
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update page — response body — object page properties value value type rollup rollup function
$ (allOf 2)JSONAll variants apply
$ (allOf 2) (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value type rollup rollup value Number
$ (allOf 2) (anyOf 2)ModelAlternativeExpand Update page — response body — object page properties value value type rollup rollup value Date
$ (allOf 2) (anyOf 3)ModelAlternativeExpand Update page — response body — object page properties value value type rollup rollup value Array
$ (allOf 2) (anyOf 4)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
functionstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
arrayarrayRequired within parentMaximum items: 100
array[]ModelEach itemExpand Update page — response body — object page properties value value value
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRoot
dateJSONRequired within parent
date (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Date date end, start, time zone
date (anyOf 2)nullAlternative
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRoot
numberJSONRequired within parent
number (anyOf 1)JSONAlternative
number (anyOf 1) (anyOf 1)numberAlternative
number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number (anyOf 2)nullAlternative
typestringRequired within parentAlways `number`
Must equal: number

Update page — response body — object page properties value value type rollup rollup value Unsupported

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

Referenced models: List views — response body — view

Update page — response body — object page properties value value value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value value value — simple Property Value Response
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
buttonModelRequired within parentExpand List views — response body — view
typestringRequired within parentAlways `button`
Must equal: button

Referenced models: List views — response body — view

Update page — response body — object page properties value value value value Checkbox

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
checkboxbooleanRequired within parent
typestringRequired within parentAlways `checkbox`
Must equal: checkbox

Update page — response body — object page properties value value value value Created By

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
created_byModelRequired within parentExpand Retrieve a page property item — response body — value Verification verification value Verified verified by value
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
created_timestringRequired within parentFormat: date-time
typestringRequired within parentAlways `created_time`
Must equal: created_time

Update page — response body — object page properties value value value value Date

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
dateJSONRequired within parent
date (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Date date end, start, time zone
date (anyOf 2)nullAlternative
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
emailJSONRequired within parent
email (anyOf 1)stringAlternative
email (anyOf 2)nullAlternative
typestringRequired within parentAlways `email`
Must equal: email

Update page — response body — object page properties value value value value Files

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
filesarrayRequired within parentMaximum items: 100
files[]ModelEach itemExpand Retrieve a page property item — response body — value Files files item
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
formulaModelRequired within parentExpand Update page — response body — object page properties value value value value Formula formula
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value value value Formula formula Boolean
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page properties value value value value Date
$ (anyOf 3)ModelAlternativeExpand Update page — response body — object page properties value value value value Number
$ (anyOf 4)ModelAlternativeExpand Update page — response body — object page properties value value value value Formula formula String
$ (anyOf 5)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
booleanJSONRequired within parent
boolean (anyOf 1)booleanAlternative
boolean (anyOf 2)nullAlternative
typestringRequired within parentAlways `boolean`
Must equal: boolean

Update page — response body — object page properties value value value value Formula formula String

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
stringJSONRequired within parent
string (anyOf 1)stringAlternative
string (anyOf 2)nullAlternative
typestringRequired within parentAlways `string`
Must equal: string

Update page — response body — object page properties value value value value Formula formula Unsupported

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
typestringRequired within parentAlways `unsupported`
Must equal: unsupported
unsupportedModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
last_edited_byModelRequired within parentExpand Retrieve a page property item — response body — value Verification verification value Verified verified by value
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
last_edited_timestringRequired within parentFormat: date-time
typestringRequired within parentAlways `last_edited_time`
Must equal: last_edited_time

Update page — response body — object page properties value value value value Multi Select

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
multi_selectarrayRequired within parentMaximum items: 100
multi_select[]ModelEach itemExpand Update page — response body — object page properties value value value value Multi Select multi select item
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
colorstringRequired within parentOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
Known values: default, gray, brown, orange, yellow, green, blue, purple, pink, red
idstringRequired within parent
namestringRequired within parent

Update page — response body — object page properties value value value value Number

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
numberJSONRequired within parent
number (anyOf 1)JSONAlternative
number (anyOf 1) (anyOf 1)numberAlternative
number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number (anyOf 2)nullAlternative
typestringRequired within parentAlways `number`
Must equal: number

Update page — response body — object page properties value value value value People

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
peoplearrayRequired within parentMaximum items: 100
people[]JSONEach item
people[] (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Verification verification value Verified verified by value
people[] (anyOf 2)ModelAlternativeExpand Update page — response body — object page properties value value value value People people item object group
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the group.
Format: uuid
nameJSONRequired within parentThe name of the group.
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
objectstringRequired within parentThe group object type name.
Must equal: group

Update page — response body — object page properties value value value value Phone Number

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternative
phone_number (anyOf 2)nullAlternative
typestringRequired within parentAlways `phone_number`
Must equal: phone_number

Update page — response body — object page properties value value value value Place

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
placeJSONRequired within parent
place (anyOf 1)ModelAlternativeExpand 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)nullAlternative
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
addressJSONOptional
address (anyOf 1)stringAlternative
address (anyOf 2)nullAlternative
aws_place_idJSONOptional
aws_place_id (anyOf 1)stringAlternative
aws_place_id (anyOf 2)nullAlternative
google_place_idJSONOptional
google_place_id (anyOf 1)stringAlternative
google_place_id (anyOf 2)nullAlternative
latJSONRequired within parent
lat (anyOf 1)numberAlternative
lat (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lonJSONRequired within parent
lon (anyOf 1)numberAlternative
lon (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative

Update page — response body — object page properties value value value value Relation

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
relationarrayRequired within parentMaximum items: 100
relation[]ModelEach itemExpand Update page — request body — body properties value type relation relation item
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
rich_textarrayRequired within parentMaximum items: 100
rich_text[]ModelEach itemExpand Retrieve a page property item — response body — value Title title
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
selectJSONRequired within parent
select (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value value value Multi Select multi select item
select (anyOf 2)nullAlternative
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
statusJSONRequired within parent
status (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value value value Multi Select multi select item
status (anyOf 2)nullAlternative
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
titlearrayRequired within parentMaximum items: 100
title[]ModelEach itemExpand Retrieve a page property item — response body — value Title title
typestringRequired within parentAlways `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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
typestringRequired within parentAlways `unique_id`
Must equal: unique_id
unique_idModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
numberJSONRequired within parent
number (anyOf 1)JSONAlternative
number (anyOf 1) (anyOf 1)numberAlternative
number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number (anyOf 2)nullAlternative
prefixJSONRequired within parent
prefix (anyOf 1)stringAlternative
prefix (anyOf 2)nullAlternative

Update page — response body — object page properties value value value value Url

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
typestringRequired within parentAlways `url`
Must equal: url
urlJSONRequired within parent
url (anyOf 1)stringAlternative
url (anyOf 2)nullAlternative

Update page — response body — object page properties value value value value Verification

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
typestringRequired within parentAlways `verification`
Must equal: verification
verificationJSONRequired within parent
verification (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Verification verification value
verification (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value value value Title
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page properties value value value value Rich Text
$ (anyOf 3)ModelAlternativeExpand Update page — response body — object page properties value value value value People
$ (anyOf 4)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value value value Number
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page properties value value value value Url
$ (anyOf 3)ModelAlternativeExpand Update page — response body — object page properties value value value value Select
$ (anyOf 4)ModelAlternativeExpand Update page — response body — object page properties value value value value Multi Select
$ (anyOf 5)ModelAlternativeExpand Update page — response body — object page properties value value value value Status
$ (anyOf 6)ModelAlternativeExpand Update page — response body — object page properties value value value value Date
$ (anyOf 7)ModelAlternativeExpand Update page — response body — object page properties value value value value Email
$ (anyOf 8)ModelAlternativeExpand Update page — response body — object page properties value value value value Phone Number
$ (anyOf 9)ModelAlternativeExpand Update page — response body — object page properties value value value value Checkbox
$ (anyOf 10)ModelAlternativeExpand Update page — response body — object page properties value value value value Files
$ (anyOf 11)ModelAlternativeExpand Update page — response body — object page properties value value value value Created By
$ (anyOf 12)ModelAlternativeExpand Update page — response body — object page properties value value value value Created Time
$ (anyOf 13)ModelAlternativeExpand Update page — response body — object page properties value value value value Last Edited By
$ (anyOf 14)ModelAlternativeExpand Update page — response body — object page properties value value value value Last Edited Time
$ (anyOf 15)ModelAlternativeExpand Update page — response body — object page properties value value value value Formula
$ (anyOf 16)ModelAlternativeExpand Update page — response body — object page properties value value value value Button
$ (anyOf 17)ModelAlternativeExpand Update page — response body — object page properties value value value value Unique Id
$ (anyOf 18)ModelAlternativeExpand Update page — response body — object page properties value value value value Verification
$ (anyOf 19)ModelAlternativeExpand Update page — response body — object page properties value value value value Place

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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
coverJSONRequired within parentPage cover image.
cover (anyOf 1)ModelAlternativeExpand Update page — response body — object page cover value
cover (anyOf 2)nullAlternative
created_byModelRequired within parentExpand Update page — response body — object page created by
User who created the page.
created_timestringRequired within parentDate and time when this page was created.
Format: date-time
iconJSONRequired within parentPage icon.
icon (anyOf 1)ModelAlternativeExpand Get agent — response body — icon value
icon (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the page.
Format: uuid
in_trashbooleanRequired within parentWhether the page is in trash.
is_archivedbooleanRequired within parentWhether the page has been archived.
is_lockedbooleanRequired within parentWhether the page is locked from editing in the Notion app UI.
last_edited_byModelRequired within parentExpand Update page — response body — object page created by
User who last edited the page.
last_edited_timestringRequired within parentDate and time when this page was last edited.
Format: date-time
objectstringRequired within parentThe page object type name.
Must equal: page
parentModelRequired within parentExpand Update page — response body — object page parent
Information about the page's parent.
propertiesobjectRequired within parentProperty values of this page.
Additional keys: see wildcard field
properties.*ModelAdditional keysExpand Update page — response body — object page properties value
public_urlJSONRequired within parentThe public URL of the Notion page, if it has been published to the web.
public_url (anyOf 1)stringAlternative
public_url (anyOf 2)nullAlternative
urlstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the page.
Format: uuid
objectstringRequired within parentThe page object type name.
Must equal: page

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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