Page properties

👍
Page properties are most useful when interacting with a page that is an entry in a database, represented as a row in the Notion UI.
If a page is not part of a database, then its only available property is its title.

A page object is made up of page properties that contain data about the page.

When you send a request to Create a page, you set the page properties in the properties object body param.

Retrieve a page gets the identifier, type, and value of a page’s properties. Retrieve a page property item returns information about a single property ID.

An Update page query modifies the page property values specified in the properties object body param.

Each page property value object contains the following fields:

Field	Type	Description	Example value
`id`	`string`	An underlying identifier for the property. `id` may be used in place of name when creating or updating pages. `id` remains constant when the property name changes.	`"f%5C%5C%3Ap"`
`type`	`string` (enum)	The type of the property in the page object. Possible type values are: - `checkbox` - `created_by` - `created_time` - `date` - `email` - `files` - `formula` - `last_edited_by` - `last_edited_time` - `multi_select` - `number` - `people` - `phone_number` - `relation` - `rollup` - `rich_text` - `select` - `status` - `title` - `url` - `unique_id` - `verification`Refer to specific type sections below for details on type-specific values.	`"rich_text"`
`checkbox` `created_by` `created_time` `date` `email` `files` `formula` `last_edited_by` `last_edited_time` `multi_select` `number` `people` `phone_number` `relation` `rollup` `rich_text` `select` `status` `title` `url` `unique_id` `verification`	`object`	A type object that contains data specific to the page property type, including the page property value. Refer to the type objects section for descriptions and examples of each type.	`"checkbox": true`

📘
Size limits for page property values
For information about size limitations for specific page property objects, refer to the limits for property values documentation.

Type objects

Checkbox

Field	Type	Description	Example value
`checkbox`	`boolean`	Whether the checkbox is checked (`true`) or unchecked (`false`).	`true`

Example `properties` body param for a POST or PATCH page request that creates or updates a `checkbox` page property value

{
  "properties": {
    "Task completed": {
      "checkbox": true
    }
  }
}

Example `checkbox` page property value as returned in a GET page request

{
  "Task completed": {
    "id": "ZI%40W",
    "type": "checkbox",
    "checkbox": true
  }
}

Created by

Field	Type	Description	Example value
`created_by`	`object`	A user object containing information about the user who created the page. `created_by` can’t be updated.	Refer to the example response objects below.

Example `created_by` page property value as returned in a GET page request

{
  "created_by": {
    "object": "user",
    "id": "c2f20311-9e54-4d11-8c79-7398424ae41e"
  }
}

Created time

Field	Type	Description	Example value
`created_time`	`string` (ISO 8601 date and time)	The date and time that the page was created. The `created_time` value can’t be updated.	`"2022-10-12T16:34:00.000Z"`

Example `created_time` page property value as returned in a GET page request

{
  "Created time": {
    "id": "eB_%7D",
    "type": "created_time",
    "created_time": "2022-10-24T22:54:00.000Z"
  }
}

Date

If the type of a page property value is "date", then the property value contains a "date" object with the following fields:

Field	Type	Description	Example value
`end`	`string` (ISO 8601 date and time)	(Optional) A string representing the end of a date range. If the value is `null`, then the date value is not a range.	`"2020-12-08T12:00:00Z"`
`start`	`string` (ISO 8601 date and time)	A date, with an optional time. If the `date` value is a range, then `start` represents the start of the range.	`"2020-12-08T12:00:00Z”`

Example `properties` body param for a POST or PATCH page request that creates or updates a date page property value

{
  "properties": {
    "Due date": {
      "date": {
        "start": "2023-02-23"
      }
    }
  }
}

Example `date` page property value as returned in a GET page request

{
  "Due date": {
    "id": "M%3BBw",
    "type": "date",
    "date": {
      "start": "2023-02-07",
      "end": null,
      "time_zone": null
    }
  }
}

Email

Field	Type	Description	Example value
`email`	`string`	A string describing an email address.	`"[email protected]"`

Example `properties` body param for a POST or PATCH page request that creates or updates an `email` page property value

{
  "properties": {
    "Email": {
      "email": "[email protected]"
    }
  }
}

Example `email` page property value as returned in a GET page request

{
  "Email": {
    "id": "y%5C%5E_",
    "type": "email",
    "email": "[email protected]"
  }
}

Files

📘
The Notion API does not yet support uploading files to Notion.

Field	Type	Description	Example value
`files`	array of file objects	An array of objects containing information about the files.	Refer to the example response objects below.

Example `properties` body param for a POST or PATCH page request that creates or updates a `files` page property value. Please note both `name` and `external`are required fields.

{
  "properties": {
    "Blueprint": {
      "files": [
        {
          "name": "Project Alpha blueprint",
          "external": {
            "url": "https://www.figma.com/file/g7eazMtXnqON4i280CcMhk/project-alpha-blueprint?node-id=0%3A1&t=nXseWIETQIgv31YH-1"
          }
        }
      ]
    }
  }
}

Example `files` page property value as returned in a GET page request

{
  "Blueprint": {
    "id": "tJPS",
    "type": "files",
    "files": [
      {
        "name": "Project blueprint",
        "type": "external",
        "external": {
          "url": "https://www.figma.com/file/g7eazMtXnqON4i280CcMhk/project-alpha-blueprint?node-id=0%3A1&t=nXseWIETQIgv31YH-1"
        }
      }
    ]
  }
}

📘
When updating a file page property value, the value is overwritten by the array of files passed.
Although Notion doesn't support uploading files via the API, if you pass a file object containing a file hosted by Notion, it remains one of the files. To remove any file, just don't pass it in the update response.

Formula

Formula property value objects represent the result of evaluating a formula described in the
database's properties.

If the type of a page property value is "formula", then the property value contains a "formula" object with the following fields:

Field	Type	Description	Example value
`boolean` \|\| `date` \|\| `number` \|\| `string`	`boolean` \|\| `date` \|\| `number` \|\| `string`	The value of the result of the formula. The value can’t be updated directly via the API.	42
`type`	`string` (enum)	A string indicating the data type of the result of the formula. Possible `type` values are: - `boolean` - `date` - `number` - `string`	`"number"`

Example `formula` page property value as returned in a GET page request

{
  "Days until launch": {
    "id": "CSoE",
    "type": "formula",
    "formula": {
      "type": "number",
      "number": 56
    }
  }
}

📘
The Retrieve a page endpoint returns a maximum of 25 inline page or person references for a formula property. If a formula property includes more than 25 references, then you can use the Retrieve a page property item endpoint for the specific formula property to get its complete list of references.

Last edited by

Field	Type	Description	Example value
`last_edited_by`	`object`	A user object containing information about the user who last updated the page. `last_edited_by` can’t be updated.	Refer to the example response objects below.

Example `last_edited_by` page property value as returned in a GET page request

{
  "Last edited by column name": {
    "id": "uGNN",
    "type": "last_edited_by",
    "last_edited_by": {
      "object": "user",
      "id": "9188c6a5-7381-452f-b3dc-d4865aa89bdf",
      "name": "Test Integration",
      "avatar_url": "https://s3-us-west-2.amazonaws.com/public.notion-static.com/3db373fe-18f6-4a3c-a536-0f061cb9627f/leplane.jpeg",
      "type": "bot",
      "bot": {}
    }
  }
}

Last edited time

Field	Type	Description	Example value
`last_edited_time`	`string` (ISO 8601 date and time)	The date and time that the page was last edited. The `last_edited_time` value can’t be updated.	`"2022-10-12T16:34:00.000Z"`

Example `last_edited_time` page property value as returned in a GET page request

{
  "Last edited time": {
    "id": "%3Defk",
    "type": "last_edited_time",
    "last_edited_time": "2023-02-24T21:06:00.000Z"
  } 
}

Multi-select

If the type of a page property value is "multi_select", then the property value contains a "multi_select" array with the following fields:

Field	Type	Description	Example value
`color`	`string` (enum)	Color of the option. Possible `"color"` values are: - `blue` - `brown` - `default` - `gray` - `green` - `orange` - `pink"` - `"purple` - `red` - `yellow`Defaults to `default`. The `color` value can’t be updated via the API.	`"red"`
`id`	`string`	The ID of the option. You can use `id` or `name` to update a multi-select property.	`"b3d773ca-b2c9-47d8-ae98-3c2ce3b2bffb"`
`name`	`string`	The name of the option as it appears in Notion. If the multi-select database property does not yet have an option by that name, then the name will be added to the database schema if the integration also has write access to the parent database. Note: Commas (`","`) are not valid for select values.	`"JavaScript"`

Example `properties` body param for a POST or PATCH page request that creates or updates a `multi_select` page property value

{
  "properties": {
    "Programming language": {
      "multi_select": [
        {
          "name": "TypeScript"
        },
        {
          "name": "Python"
        }
      ]
    }
  }
}

Example `multi_select` page property value as returned in a GET page request

{
  "Programming language": {
    "id": "QyRn",
    "name": "Programming language",
    "type": "multi_select",
    "multi_select": {
      "options": [
        {
          "id": "tC;=",
          "name": "TypeScript",
          "color": "purple"
        },
        {
          "id": "e4413a91-9f84-4c4a-a13d-5b4b3ef870bb",
          "name": "JavaScript",
          "color": "red"
        },
        {
          "id": "fc44b090-2166-40c8-8c58-88f2d8085ec0",
          "name": "Python",
          "color": "gray"
        }
      ]
    }
  }
}

📘
If you want to add a new option to a multi-select property via the Update page or Update database endpoint, then your integration needs write access to the parent database.

Number

Field	Type	Description	Example value
`number`	`number`	A number representing some value.	`1234`

Example `properties` body param for a POST or PATCH page request that creates or updates a `number` page property value

{
  "properties": {
    "Number of subscribers": {
      "number": 42
    }
  }
}

Example `number` page property value as returned in a GET page request

{
  "Number of subscribers": {
    "id": "WPj%5E",
    "name": "Number of subscribers",
    "type": "number",
    "number": {
      "format": "number"
    }
  }
}

People

Field	Type	Description	Example value
`people`	array of user objects	An array of user objects.	Refer to the example response objects below.

Example `properties` body param for a POST or PATCH page request that creates or updates a `people` page property value

{
  "properties": {
    "Stakeholders": {
      "people": [{
        "object": "user",
        "id": "c2f20311-9e54-4d11-8c79-7398424ae41e"
      }]
    }
  }
}

Example `people` page property value as returned in a GET page request

{
  "Stakeholders": {
    "id": "%7BLUX",
    "type": "people",
    "people": [
      {
        "object": "user",
        "id": "c2f20311-9e54-4d11-8c79-7398424ae41e",
        "name": "Kimberlee Johnson",
        "avatar_url": null,
        "type": "person",
        "person": {
          "email": "[email protected]"
        }
      }
    ]
  }
}

📘
The Retrieve a page endpoint can’t be guaranteed to return more than 25 people per people page property. If a people page property includes more than 25 people, then you can use the Retrieve a page property item endpoint for the specific people property to get a complete list of people.

Phone number

Field	Type	Description	Example value
`phone_number`	`string`	A string representing a phone number. No phone number format is enforced.	`"415-867-5309"`

Example `properties` body param for a POST or PATCH page request that creates or updates a `phone_number` page property value

{
  "properties": {
    "Contact phone number": {
      "phone_number": "415-202-4776"
    }
  }
}

Example `phone_number` page property value as returned in a GET page request

{
  "Example phone number property": {
    "id": "%5DKhQ",
    "name": "Example phone number property",
    "type": "phone_number",
    "phone_number": {}
  }
}

Relation

Field	Type	Description	Example value
`has_more`	`boolean`	If a `relation` has more than 25 references, then the `has_more` value for the relation in the response object is `true`. If a relation doesn’t exceed the limit, then `has_more` is `false`.	Refer to the example response objects below.
`relation`	an array of page references	An array of related page references. A page reference is an object with an `id` key and a string value corresponding to a page ID in another database.	Refer to the example response objects below.

Example `properties` body param for a POST or PATCH page request that creates or updates a `relation` page property value

{
  "properties": {
    "Related tasks": {
      "relation": [
        {
          "id": "dd456007-6c66-4bba-957e-ea501dcda3a6"
        },
        {
          "id": "0c1f7cb2-8090-4f18-924e-d92965055e32"
        }
      ]
    }
  }
}

Example `relation` page property value as returned in a GET page request

{
  "Related tasks": {
    "id": "hgMz",
    "type": "relation",
    "relation": [
      {
        "id": "dd456007-6c66-4bba-957e-ea501dcda3a6"
      },
      {
        "id": "0c1f7cb2-8090-4f18-924e-d92965055e32"
      }
    ],
    "has_more": false
  } 
}

📘
To update a relation property value via the API, share the related parent database with the integration.

📘
If a relation property value is unexpectedly empty, then make sure that you have shared the original source database that the relation points to with the integration.

Rollup

If the type of a page property value is "rollup", then the property value contains a "rollup" object with the following fields:

Field	Type	Description	Example value
`array` \|\| `date` \|\| `incomplete` \|\| `number` \|\| `unsupported`	Corresponds to the field. For example, if the field is `number`, then the type of the value is `number`.	The value of the calculated rollup. The value can't be directly updated via the API.	`1234`
`function`	`string` (enum)	The function that is evaluated for every page in the relation of the rollup. Possible `"function"` values are: - `average` - `checked` - `count` - `count_per_group` - `count_values` - `date_range` - `earliest_date` - `empty` - `latest_date` - `max` - `median` - `min` - `not_empty` - `percent_checked` - `percent_empty` - `percent_not_empty` - `percent_per_group` - `percent_unchecked` - `range` - `show_original` - `show_unique` - `sum` - `unchecked` - `unique`	`"sum"`
`type`	`array` \|\| `date` \|\| `incomplete` \|\| `number` \|\| `unsupported`	The value type of the calculated rollup.	`number`

Example `rollup` page property value as returned in a GET page request

{
  "Number of units": {
    "id": "hgMz",
    "type": "rollup",
    "rollup": {
      "type": "number",
      "number": 2,
      "function": "count"
    }
  }
}

🚧
For rollup properties with more than 25 references, use the Retrieve a page property endpoint
Both the Retrieve a page and Retrieve a page property endpoints will return information related to the page properties. In cases where a rollup property has more than 25 references, the Retrieve a page property endpoint must but used.
Learn more about rollup properties in Notion’s Help Center.

🚧
The API does not support updating rollup page property values.
To change a page's rollup property, use the Notion UI.

Rich text

Field	Type	Description	Example value
`rich_text`	an array of rich text objects	An array of rich text objects	Refer to the example response objects below.

Example `properties` body param for a POST or PATCH page request that creates or updates a `rich_text` page property value

{
  "properties": {
    "Description": {
      "rich_text": [
        {
          "type": "text",
          "text": {
            "content": "There is some ",
            "link": null
          },
          "annotations": {
            "bold": false,
            "italic": false,
            "strikethrough": false,
            "underline": false,
            "code": false,
            "color": "default"
          },
          "plain_text": "There is some ",
          "href": null
        },
        {
          "type": "text",
          "text": {
            "content": "text",
            "link": null
          },
          "annotations": {
            "bold": true,
            "italic": false,
            "strikethrough": false,
            "underline": false,
            "code": false,
            "color": "default"
          },
          "plain_text": "text",
          "href": null
        },
        {
          "type": "text",
          "text": {
            "content": " in this property!",
            "link": null
          },
          "annotations": {
            "bold": false,
            "italic": false,
            "strikethrough": false,
            "underline": false,
            "code": false,
            "color": "default"
          },
          "plain_text": " in this property!",
          "href": null
        }
      ]
    }
  }
}

Example `rich_text` page property value as returned in a GET page request

{
  "Description": {
    "id": "HbZT",
    "type": "rich_text",
    "rich_text": [
      {
        "type": "text",
        "text": {
          "content": "There is some ",
          "link": null
        },
        "annotations": {
          "bold": false,
          "italic": false,
          "strikethrough": false,
          "underline": false,
          "code": false,
          "color": "default"
        },
        "plain_text": "There is some ",
        "href": null
      },
      {
        "type": "text",
        "text": {
          "content": "text",
          "link": null
        },
        "annotations": {
          "bold": true,
          "italic": false,
          "strikethrough": false,
          "underline": false,
          "code": false,
          "color": "default"
        },
        "plain_text": "text",
        "href": null
      },
      {
        "type": "text",
        "text": {
          "content": " in this property!",
          "link": null
        },
        "annotations": {
          "bold": false,
          "italic": false,
          "strikethrough": false,
          "underline": false,
          "code": false,
          "color": "default"
        },
        "plain_text": " in this property!",
        "href": null
      }
    ]
  } 
}

📘
The Retrieve a page endpoint returns a maximum of 25 populated inline page or person references for a rich_text property. If a rich_text property includes more than 25 references, then you can use the Retrieve a page property item endpoint for the specific rich_text property to get its complete list of references.

Select

If the type of a page property value is select, then the property value contains a select object with the following fields:

Property	Type	Description	Example value
`color`	`string` (enum)	The color of the option. Possible `"color"` values are: - `blue` - `brown` - `default` - `gray` - `green` - `orange` - `pink` - `purple` - `red` - yellow`Defaults to `default`. The `color` value can’t be updated via the API.	`red`
`id`	`string`	The ID of the option. You can use `id` or `name` to update a select property.	`"b3d773ca-b2c9-47d8-ae98-3c2ce3b2bffb"`
`name`	`string`	The name of the option as it appears in Notion. If the select database property doesn't have an option by that name yet, then the name is added to the database schema if the integration also has write access to the parent database. Note: Commas (`","`) are not valid for select values.	`"jQuery"`

Example `properties` body param for a POST or PATCH page request that creates or updates a `select` page property value

{
  "properties": {
    "Department": {
      "select": {
        "name": "Marketing"
      }
    }
  }
}

Example select page property value as returned in a GET page request

{
  "Department": {
    "id": "Yc%3FJ",
    "type": "select",
    "select": {
      "id": "ou@_",
      "name": "jQuery",
      "color": "purple"
    }
  }
}

Status

If the type of a page property value is status, then the property value contains a status object with the following fields:

Property	Type	Description	Example value
`color`	`string` (enum)	The color of the option. Possible `"color"` values are: - `blue` - `brown` - `default` - `gray` - `green` - `orange` - `pink` - `purple` - `red` - `yellow`Defaults to `default`. The `color` value can’t be updated via the API.	`"red"`
`id`	`string`	`string`	`"b3d773ca-b2c9-47d8-ae98-3c2ce3b2bffb"`
`name`	`string`	The name of the option as it appears in Notion.	`"In progress"`

Example `properties` body param for a POST or PATCH page request that creates or updates a `status` page property value

{
  "properties": {
    "Status": {
      "status": {
        "name": "Not started"
      }
    }
  }
}

Example `status` page property value as returned in a GET page request

{
  "Status": {
    "id": "Z%3ClH",
    "type": "status",
    "status": {
      "id": "539f2705-6529-42d8-a215-61a7183a92c0",
      "name": "In progress",
      "color": "blue"
    }
  }
}

Title

Field	Type	Description	Example value
`title`	an array of rich text objects	An array of rich text objects.	Refer to the example response objects below.

Example `properties` body param for a POST or PATCH page request that creates or updates a `title` page property value

{
  "properties": {
    "Title": {
      "id": "title",
      "type": "title",
      "title": [
        {
          "type": "text",
          "text": {
            "content": "A better title for the page",
            "link": null
          },
          "annotations": {
            "bold": false,
            "italic": false,
            "strikethrough": false,
            "underline": false,
            "code": false,
            "color": "default"
          },
          "plain_text": "This is also not done",
          "href": null
        }
      ]
    }
  }
}

Example `title` page property value as returned in a GET page request

{
  "Title": {
    "id": "title",
    "type": "title",
    "title": [
      {
        "type": "text",
        "text": {
          "content": "A better title for the page",
          "link": null
        },
        "annotations": {
          "bold": false,
          "italic": false,
          "strikethrough": false,
          "underline": false,
          "code": false,
          "color": "default"
        },
        "plain_text": "This is also not done",
        "href": null
      }
    ]
  }
}

📘
The Retrieve a page endpoint returns a maximum of 25 inline page or person references for a title property. If a title property includes more than 25 references, then you can use the Retrieve a page property item endpoint for the specific title property to get its complete list of references.

URL

Field	Type	Description	Example value
`url`	`string`	A string that describes a web address.	`"https://developers.notion.com/"`

Example `properties` body param for a POST or PATCH page request that creates or updates a `url` page property value

{
  "properties": {
    "Website": {
      "url": "https://developers.notion.com/"
    }
  }
}

Example `url` page property value as returned in a GET page request

{
  "Website": {
    "id": "bB%3D%5B",
    "type": "url",
    "url": "https://developers.notion.com/"
  }
}

Unique ID

Field	Type	Description	Example value
`number`	`number`	The ID count (auto-incrementing).	3
`prefix`	`string` or `null`	An optional prefix to be applied to the unique ID.	"RL"

👍
Unique IDs can be read using the API with a GET page request, but they cannot be updated with the API, since they are auto-incrementing.

Example `url` page property value as returned in a GET page request

{
  "test-ID": {
    "id": "tqqd",
    "type": "unique_id",
    "unique_id": {
      "number": 3,
      "prefix": "RL",
    },
  },
}

Verification

The verification status of a page in a wiki database. Pages can be verified or unverified, and verifications can have an optional expiration date set.

The verification status cannot currently be set or updated via the public API.

📘
The verification property is only available for pages that are part of a wiki database. To learn more about wiki databases and verifying pages, see our Help Center article.

Field	Type	Description	Example value
`state`	`string`	The verification state of the page. `"verified"` or `"unverified"`.	`"unverified"`
`verified_by`	User object or `null`	If the page if verified, a User object will be included to indicate the user who verified the page.	Refer to the example response objects below.
`date`	Object or `null`	If the page is verified, the date object will include the date the verification started (`start`). If an expiration date is set for the verification, an end date (`end`) will be included. (ISO 8601 date and time.)	Refer to the example response objects below.

Example `verification` page property values as returned in a GET page request

Unverified

{
  Verification: {
    id: "fpVq",
    type: "verification",
    verification: { state: "unverified", verified_by: null, date: null },
  },
}

Verified with no expiration date set

{
  Verification: {
    id: "fpVq",
    type: "verification",
    verification: {
      state: "verified",
      verified_by: {
        object: "user",
        id: "01e46064-d5fb-4444-8ecc-ad47d076f804",
        name: "User Name",
        avatar_url: null,
        type: "person",
        person: {},
      },
      date: { start: "2023-08-01T04:00:00.000Z", end: null, time_zone: null },
    },
  },
}

Verified with 90-day expiration date

{
  Verification: {
    id: "fpVq",
    type: "verification",
    verification: {...},
      date: {
        start: "2023-08-01T04:00:00.000Z",
        end: "2023-10-30T04:00:00.000Z",
        time_zone: null,
      },
    },
  },
}

Paginated page properties

The title, rich_text, relation and people page properties are returned as a paginated list object of individual property_item objects.

An abridged set of the the properties found in the list object is below. Refer to the pagination documentation for additional information.

Field	Type	Description	Example value
`object`	`"list"`	Always `"list"`.	`"list"`
`type`	`"property_item"`	Always `"property_item"`.	`"property_item"`
`results`	`list`	List of `property_item` objects.	`[{"object": "property_item", "id": "vYdV", "type": "relation", "relation": { "id": "535c3fb2-95e6-4b37-a696-036e5eac5cf6"}}... ]`
`property_item`	`object`	A `property_item` object that describes the property.	`{"id": "title", "next_url": null, "type": "title", "title": {}}`
`next_url`	`string` or `null`	The URL the user can request to get the next page of results.	`"http://api.notion.com/v1/pages/0e5235bf86aa4efb93aa772cce7eab71/properties/vYdV?start_cursor=LYxaUO&page_size=25"`

👍

📘Size limits for page property values

Type objects

Checkbox

Example properties body param for a POST or PATCH page request that creates or updates a checkbox page property value

Example checkbox page property value as returned in a GET page request

Created by

Example created_by page property value as returned in a GET page request

Created time

Example created_time page property value as returned in a GET page request

Date

Example properties body param for a POST or PATCH page request that creates or updates a date page property value

Example date page property value as returned in a GET page request

Email

Example properties body param for a POST or PATCH page request that creates or updates an email page property value

Example email page property value as returned in a GET page request

Files

📘

Example properties body param for a POST or PATCH page request that creates or updates a files page property value. Please note both name and externalare required fields.

Example files page property value as returned in a GET page request

📘When updating a file page property value, the value is overwritten by the array of files passed.

Formula

Example formula page property value as returned in a GET page request

📘

Last edited by

Example last_edited_by page property value as returned in a GET page request

Last edited time

Example last_edited_time page property value as returned in a GET page request

Multi-select

Example properties body param for a POST or PATCH page request that creates or updates a multi_select page property value

Example multi_select page property value as returned in a GET page request

📘

Number

Example properties body param for a POST or PATCH page request that creates or updates a number page property value

Example number page property value as returned in a GET page request

People

Example properties body param for a POST or PATCH page request that creates or updates a people page property value

Example people page property value as returned in a GET page request

📘

Phone number

Example properties body param for a POST or PATCH page request that creates or updates a phone_number page property value

Example phone_number page property value as returned in a GET page request

Relation

Example properties body param for a POST or PATCH page request that creates or updates a relation page property value

Example relation page property value as returned in a GET page request

📘To update a relation property value via the API, share the related parent database with the integration.

📘

Rollup

Example rollup page property value as returned in a GET page request

🚧For rollup properties with more than 25 references, use the Retrieve a page property endpoint

🚧The API does not support updating rollup page property values.

Rich text

Example properties body param for a POST or PATCH page request that creates or updates a rich_text page property value

Example rich_text page property value as returned in a GET page request

📘

Select

Example properties body param for a POST or PATCH page request that creates or updates a select page property value

Example select page property value as returned in a GET page request

Status

Example properties body param for a POST or PATCH page request that creates or updates a status page property value

Example status page property value as returned in a GET page request

Title

Example properties body param for a POST or PATCH page request that creates or updates a title page property value

Example title page property value as returned in a GET page request

📘

URL

Example properties body param for a POST or PATCH page request that creates or updates a url page property value

Example url page property value as returned in a GET page request

Unique ID

👍

Example url page property value as returned in a GET page request

Verification

📘

Example verification page property values as returned in a GET page request

Unverified

Verified with no expiration date set

Verified with 90-day expiration date

Paginated page properties

📘
Size limits for page property values

Example `properties` body param for a POST or PATCH page request that creates or updates a `checkbox` page property value

Example `checkbox` page property value as returned in a GET page request

Example `created_by` page property value as returned in a GET page request

Example `created_time` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a date page property value

Example `date` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates an `email` page property value

Example `email` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a `files` page property value. Please note both `name` and `external`are required fields.

Example `files` page property value as returned in a GET page request

📘
When updating a `file` page property value, the value is overwritten by the array of files passed.

Example `formula` page property value as returned in a GET page request

Example `last_edited_by` page property value as returned in a GET page request

Example `last_edited_time` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a `multi_select` page property value

Example `multi_select` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a `number` page property value

Example `number` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a `people` page property value

Example `people` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a `phone_number` page property value

Example `phone_number` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a `relation` page property value

Example `relation` page property value as returned in a GET page request

📘
To update a `relation` property value via the API, share the related parent database with the integration.

Example `rollup` page property value as returned in a GET page request

🚧
For rollup properties with more than 25 references, use the Retrieve a page property endpoint

🚧
The API does not support updating `rollup` page property values.

Example `properties` body param for a POST or PATCH page request that creates or updates a `rich_text` page property value

Example `rich_text` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a `select` page property value

Example `properties` body param for a POST or PATCH page request that creates or updates a `status` page property value

Example `status` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a `title` page property value

Example `title` page property value as returned in a GET page request

Example `properties` body param for a POST or PATCH page request that creates or updates a `url` page property value

Example `url` page property value as returned in a GET page request

Example `url` page property value as returned in a GET page request

Example `verification` page property values as returned in a GET page request