Developer API
Get Page Property
V2

Get Page Property

Read one page property value by property ID, including paginated property items.

GET /v2/pages/:page_id/properties/:property_id

Get Page Property

Use Case

Use this endpoint to read one page property by property ID. It is useful for large or list-like property values that may be returned as paginated property_item lists.

Endpoint

Item Value
Method GET
Path /v2/pages/:page_id/properties/:property_id
Request body None
Returns property_item or a paginated list of property_item objects
Scope pages.read

Permissions

Requires pages.read and access to the page.

Parameters

Parameter Type Required Description
page_id string Yes Page ID.
property_id string Yes Property ID or encoded property name.
start_cursor string No Pagination cursor for paginated property values.
page_size number No Defaults to 20; maximum is 100.

Response Example

{
  "object": "property_item",
  "id": "title",
  "type": "title",
  "title": [
    {
      "type": "text",
      "text": {
        "content": "Launch Plan",
        "link": null
      },
      "plain_text": "Launch Plan",
      "href": null
    }
  ]
}

Behavior

  • Simple property values return one property_item object.
  • List-like values can return a list response with property_item results.
  • Use next_cursor and has_more for pagination.
  • The property value type follows the page property model.

Errors

  • 400 validation_error: invalid pagination parameters.
  • 401 unauthorized: invalid or expired token.
  • 403 forbidden: missing pages.read or no access.
  • 404 not_found: page or property does not exist.

Prerequisites

Next Steps

References