Retrieve page property item

Developers can now individually retrieve the value of their page properties with the Retrieve a page property endpoint! This includes pagination through a list of property item objects for properties with long values or lots of page references such as formula, relations and rollups. See the documentation for more info. Use the Retrieve a database endpoint to obtain the property_id .

Simple Property Types

Most properties will be identified by a type with the property value in the object found in key {type},

Example Request/Response

cURL

curl --request GET \
  --url http://localhost:3000/v1/pages/b55c9c91-384d-452b-81db-d1ef79372b75/properties/some-property-id \
  --header 'Authorization: Bearer $NOTION_API_KEY' \
  --header 'Notion-Version: 2021-08-16'

JSON

{
  "object": "property_item",
  "type": "number",
  "number": 2
}

Paginated Property Types

Properties of type title, rich_text, relation and people will return a paginated list of Property Item Objects

Example List Response

JSON

{
    "object": "list",
    "results": [
        {
            "object": "property_item",
            "type": "rich_text",
            "rich_text": {
                "type": "text",
                "text": {
                    "content": "Avocado ",
                    "link": null
                },
                "annotations": {
                    "bold": false,
                    "italic": false,
                    "strikethrough": false,
                    "underline": false,
                    "code": false,
                    "color": "default"
                },
                "plain_text": "Avocado ",
                "href": null
            }
        },
... // additional results omitted.
    ],
    "next_cursor": "some-next-cursor-value",
    "has_more": true
}

Rollup Property Types

Rollups of type ‘Show Original’, ‘Show unique’, ‘Count unique’ and ‘Median’ return a flattened list of property items. All other rollups are return a list of relations and (after pagination) a rollup property value of type date or number

Example Paginated Property Item Request/Response

A rollup page property with an aggregation that requires additional pagination.

cURL

curl --request GET \
  --url http://localhost:3000/v1/pages/b55c9c91-384d-452b-81db-d1ef79372b75/properties/some-property-id?page_size=10&start_cursor=some-cursor-value \
  --header 'Authorization: Bearer $NOTION_API_KEY' \
  --header 'Notion-Version: 2021-08-16'

JSON

{
    "object": "list",
    "results": [
        {
            "object": "property_item",
            "type": "relation",
            "relation": {
                "id": "de5d73e8-3748-40fa-9102-f1290fe2444b"
            }
        },
        {
            "object": "property_item",
            "type": "relation",
            "relation": {
                "id": "164325b0-4c9e-416b-ba9c-037b4c9acdfd"
            }
        },
        {
            "object": "property_item",
            "type": "relation",
            "relation": {
                "id": "456baa98-3239-4c1f-b0ea-bdae945aaf33"
            }
        }
      ...
    ],
    "next_cursor": "some-next-cursor-value",
    "has_more": true,
    "rollup": {
        "type": "date",
        "date": {
            "start": "2021-10-07T14:42:00.000+00:00",
            "end": null
        },
        "function": "latest_date"
    },
    "type": "rollup"
}

Get started

Agent APIs

API versions

Data APIs

Resources

Compliance

Link previews

Retrieve page property item

Simple Property Types

Example Request/Response

Paginated Property Types

Example List Response

Rollup Property Types

Example Paginated Property Item Request/Response

​Simple Property Types

​Example Request/Response

​Paginated Property Types

​Example List Response

​Rollup Property Types

​Example Paginated Property Item Request/Response

Simple Property Types

Example Request/Response

Paginated Property Types

Example List Response

Rollup Property Types

Example Paginated Property Item Request/Response