List comments | Notion

{
  "OK": {
    "value": "{\n    \"object\": \"list\",\n    \"results\": [\n        {\n            \"object\": \"comment\",\n            \"id\": \"94cc56ab-9f02-409d-9f99-1037e9fe502f\",\n            \"parent\": {\n                \"type\": \"page_id\",\n                \"page_id\": \"5c6a2821-6bb1-4a7e-b6e1-c50111515c3d\"\n            },\n            \"discussion_id\": \"f1407351-36f5-4c49-a13c-49f8ba11776d\",\n            \"created_time\": \"2022-07-15T16:52:00.000Z\",\n            \"last_edited_time\": \"2022-07-15T19:16:00.000Z\",\n            \"created_by\": {\n                \"object\": \"user\",\n                \"id\": \"9b15170a-9941-4297-8ee6-83fa7649a87a\"\n            },\n            \"rich_text\": [\n                {\n                    \"type\": \"text\",\n                    \"text\": {\n                        \"content\": \"Single comment\",\n                        \"link\": null\n                    },\n                    \"annotations\": {\n                        \"bold\": false,\n                        \"italic\": false,\n                        \"strikethrough\": false,\n                        \"underline\": false,\n                        \"code\": false,\n                        \"color\": \"default\"\n                    },\n                    \"plain_text\": \"Single comment\",\n                    \"href\": null\n                }\n            ]\n        }\n    ],\n    \"next_cursor\": null,\n    \"has_more\": false,\n    \"type\": \"comment\",\n    \"comment\": {}\n}"
  }
}

Retrieves a list of un-resolved Comment objects from a page or block.

See Pagination for details about how to use a cursor to iterate through the list.

Errors

Each Public API endpoint can return several possible error codes. See the Error codes section of the Status codes documentation for more information.

Reminder: Turn on integration comment capabilities

Integration capabilities for reading and inserting comments are off by default.

This endpoint requires an integration to have read comment capabilities. Attempting to call this endpoint without read comment capabilities will return an HTTP response with a 403 status code.

For more information on integration capabilities, see the capabilities guide. To update your integration settings, visit the integration dashboard.

Query parameters

block_idstringRequired

Identifier for a Notion block or page

start_cursorstringOptional

If supplied, this endpoint will return a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results.

page_sizeintegerOptional

The number of items from the full list desired in the response. Maximum: 100

Response

200

objectstringOptional

resultslist of objectsOptional

next_cursoranyOptional

has_morebooleanOptionalDefaults to true

typestringOptional

commentobjectOptional

Errors

403

Forbidden Error

Errors

Headers

Query parameters

Response

Errors