Skip to content

Page properties must be retrieved using the page properties endpoint. #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Tracked by #257
KoditkarVedant opened this issue Jul 10, 2022 · 0 comments · Fixed by #296, #306 or #318
Closed
Tracked by #257

Page properties must be retrieved using the page properties endpoint. #258

KoditkarVedant opened this issue Jul 10, 2022 · 0 comments · Fixed by #296, #306 or #318
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@KoditkarVedant
Copy link
Contributor

KoditkarVedant commented Jul 10, 2022

Previously, the page object returned from page endpoints, as well as the query database and search endpoint, returned a properties field that contained all the page’s properties along with its value:

"properties": {
    "Name": {
      "id": "title",
      "type": "title",
      "title": [
        {
          "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
        }
      ]
   }
}

While convenient, returning accurate results for all properties resulted in bad performance and timeouts for larger databases or pages with lots of mentions. To combat performance, on March 1st, we added a disclaimer that page objects stopped returning accurate results for pages with more than 25 mentions to other objects (which affected properties of type title, rich_text, relation, people, rollup, and formula).

In October 2021, we introduced a way to more accurately retrieve individual page properties via the retrieve a page property item endpoint. With this endpoint, we’re able to paginate complex properties that involve additional look-ups.

With version 2022-06-28, the type and property value from page objects are removed. Thus moving forward, all property value retrieval must happen through the retrieve a page property item endpoint.

"properties": {
    "Name": {
      "id": "title"
   }
}

Notion changelog: https://developers.notion.com/changelog/releasing-notion-version-2022-06-28

@KoditkarVedant KoditkarVedant added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed up for grabs labels Jul 10, 2022
@KoditkarVedant KoditkarVedant added this to the 4.0.0 milestone Jul 16, 2022
@KoditkarVedant KoditkarVedant linked a pull request Aug 20, 2022 that will close this issue
10 tasks
@KoditkarVedant KoditkarVedant removed help wanted Extra attention is needed up for grabs labels Aug 20, 2022
@KoditkarVedant KoditkarVedant self-assigned this Aug 20, 2022
@KoditkarVedant KoditkarVedant linked a pull request Aug 20, 2022 that will close this issue
@KoditkarVedant KoditkarVedant linked a pull request Sep 8, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
1 participant