(日本語版)Notion API - Public Beta
  1. ページ
(日本語版)Notion API - Public Beta
  • 概要
  • インテグレーション機能
  • リクエスト制限
  • ステータス コード
  • ブロック
  • ユーザー
  • コメント
  • リンク プレビューのUnfurl属性オブジェクト
  • バージョン変更
    • バージョニング
    • バージョンによる変更
  • ページ
    • ページ
    • ページのプロパティ
  • データベース
    • データベース
    • データベースのプロパティ
  • その他
    • 絵文字オブジェクト
    • ファイルオブジェクト
    • 親オブジェクト
    • リッチテキストオブジェクト
  • エンドポイント
    • 認証
      • 認証
      • Tokenを作成
    • ブロック
      • ブロックを取得
      • ブロックを更新
      • ブロックの子を取得
      • ブロックの子を追加
      • ブロックを削除
    • データベース
      • データベース エントリのフィルタ
      • データベース エントリの並べ替え
      • データベースのプロパティを更新する
      • データベースを作成
      • データベースを取得
      • データベースを更新
      • データベースにクエリを実行
    • ユーザー
      • 全てユーザーのリストを取得
      • トークンのボットユーザーを取得
      • ユーザーを取得
    • ページ
      • ページをアーカイブ
      • ページを作成
        POST
      • ページを取得
        GET
      • ページプロパティアイテムを取得
        GET
      • ページプロパティを更新
        PATCH
    • コメント
      • コメントを作成
      • コメントを取得
    • 検索
      • タイトルで検索
  1. ページ

ページをアーカイブ

ページをアーカイブ#

📘#

API は、ページの完全な削除をサポートしていません。これは、Notion UIと一致しています。
API 経由でページをアーカイブするには、archivedbody パラメータを trueに設定してUpdate pageリクエストを送信します。ページを復元するには、archivedをfalseに設定します。

リクエスト例: Notion ページをアーカイブする#

cURL
curl https://api.notion.com/v1/pages/60bdc8bd-3880-44b8-a9cd-8a145b3ffbd7 \
  -H 'Authorization: Bearer '"$NOTION_API_KEY"'' \
  -H "Content-Type: application/json" \
  -H "Notion-Version: 2022-06-28" \
  -X PATCH \
    --data '{
    "archived": true
}'
Notion のJavaScript SDK を使用してREST API を操作している場合は、Notion ページで使用できるupdate方法を使用してください。
JavaScript
成功した場合、API は次の例のように、200HTTP ステータス コードとアーカイブされたページ オブジェクトで応答します。
JSON
{
    "object": "page",
    "id": "be633bf1-dfa0-436d-b259-571129a590e5",
    "created_time": "2022-10-24T22:54:00.000Z",
    "last_edited_time": "2023-03-08T18:25:00.000Z",
    "created_by": {
        "object": "user",
        "id": "c2f20311-9e54-4d11-8c79-7398424ae41e"
    },
    "last_edited_by": {
        "object": "user",
        "id": "9188c6a5-7381-452f-b3dc-d4865aa89bdf"
    },
    "cover": null,
    "icon": {
        "type": "emoji",
        "emoji": "🐞"
    },
    "parent": {
        "type": "database_id",
        "database_id": "a1d8501e-1ac1-43e9-a6bd-ea9fe6c8822b"
    },
    "archived": true,
    "properties": {
        "Due date": {
            "id": "M%3BBw",
            "type": "date",
            "date": {
                "start": "2023-02-23",
                "end": null,
                "time_zone": null
            }
        },
        "Status": {
            "id": "Z%3ClH",
            "type": "status",
            "status": {
                "id": "86ddb6ec-0627-47f8-800d-b65afd28be13",
                "name": "Not started",
                "color": "default"
            }
        },
        "Title": {
            "id": "title",
            "type": "title",
            "title": [
                {
                    "type": "text",
                    "text": {
                        "content": "Bug bash",
                        "link": null
                    },
                    "annotations": {
                        "bold": false,
                        "italic": false,
                        "strikethrough": false,
                        "underline": false,
                        "code": false,
                        "color": "default"
                    },
                    "plain_text": "Bug bash",
                    "href": null
                }
            ]
        }
    },
    "url": "https://www.notion.so/Bug-bash-be633bf1dfa0436db259571129a590e5"
}
考えられるエラーについては、エラー コードのドキュメントを参照してください。

リクエスト例: Notion ページを復元する#

カール
curl https://api.notion.com/v1/pages/60bdc8bd-3880-44b8-a9cd-8a145b3ffbd7 \
  -H 'Authorization: Bearer '"$NOTION_API_KEY"'' \
  -H "Content-Type: application/json" \
  -H "Notion-Version: 2022-06-28" \
  -X PATCH \
    --data '{
    "archived": false
}'
JavaScript
成功した場合、API は200HTTP ステータス コードと復元されたページ オブジェクトを返します。考えられるエラーについては、エラー コードのドキュメントを参照してください。
更新日時 2023-04-28 09:29:47
前へ
ユーザーを取得
次へ
ページを作成
Built with