Join us for our Developer Platform Hackathon, May 16-17. Apply now →
import { Client } from "@notionhq/client"
const notion = new Client({ auth: process.env.NOTION_API_KEY })
const response = await notion.comments.list({
block_id: "b55c9c91-384d-452b-81db-d1ef79372b75",
start_cursor: undefined,
page_size: 50
}){
"object": "<string>",
"next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"has_more": true,
"results": [
{
"object": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent": {
"type": "<string>",
"page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"discussion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_time": "2023-11-07T05:31:56Z",
"last_edited_time": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>"
},
"rich_text": [
{
"plain_text": "<string>",
"href": "<string>",
"annotations": {
"bold": true,
"italic": true,
"strikethrough": true,
"underline": true,
"code": true,
"color": "default"
},
"type": "<string>",
"text": {
"content": "<string>",
"link": {
"url": "<string>"
}
}
}
],
"display_name": {
"type": "custom",
"resolved_name": "<string>"
},
"attachments": [
{
"category": "audio",
"file": {
"url": "<string>",
"expiry_time": "2023-11-07T05:31:56Z"
}
}
]
}
],
"type": "<string>",
"comment": {},
"request_status": {
"type": "complete",
"incomplete_reason": "<string>"
}
}Retrieves a list of un-resolved Comment objects from a page or block.
import { Client } from "@notionhq/client"
const notion = new Client({ auth: process.env.NOTION_API_KEY })
const response = await notion.comments.list({
block_id: "b55c9c91-384d-452b-81db-d1ef79372b75",
start_cursor: undefined,
page_size: 50
}){
"object": "<string>",
"next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"has_more": true,
"results": [
{
"object": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent": {
"type": "<string>",
"page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"discussion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_time": "2023-11-07T05:31:56Z",
"last_edited_time": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>"
},
"rich_text": [
{
"plain_text": "<string>",
"href": "<string>",
"annotations": {
"bold": true,
"italic": true,
"strikethrough": true,
"underline": true,
"code": true,
"color": "default"
},
"type": "<string>",
"text": {
"content": "<string>",
"link": {
"url": "<string>"
}
}
}
],
"display_name": {
"type": "custom",
"resolved_name": "<string>"
},
"attachments": [
{
"category": "audio",
"file": {
"url": "<string>",
"expiry_time": "2023-11-07T05:31:56Z"
}
}
]
}
],
"type": "<string>",
"comment": {},
"request_status": {
"type": "complete",
"incomplete_reason": "<string>"
}
}See Pagination for details about how to use a cursor to iterate through the list.Documentation Index
Fetch the complete documentation index at: https://developers.notion.com/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The API version to use for this request. The latest version is 2026-03-11.
2026-03-11 Identifier for a Notion block or page.
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.
The number of items from the full list desired in the response. Maximum: 100
1 <= x <= 100