概要
概要
📘
Notion API とやり取りするには、インテグレーショントークンが必要です。インテグレーション設定ページでインテグレーションを作成した後、インテグレーショントークンを見つけることができます。初めて Notion API を使用する場合は、入門ガイドから始めて、インテグレーションの作成方法を学習することをお勧めします。 特定のインテグレーションに取り組みたいが、トークンにアクセスできない場合は、関連するワークスペースの管理者であることを確認してください。Notion UI の左側のサイドバーの Settings & Members
から確認できます。どのワークスペースの管理者でもない場合は、個人用ワークスペースを無料で作成できます。
規約
https://api.notion.com
です。 すべての API リクエストに HTTPS が必要です。GET、POST、PATCH、DELETE
リクエストを介して実行されます。リクエストとレスポンスの本文は、JSON としてエンコ ードされます。JSON 規則
object
プロパティがあります。このプロパティは、リソースのタイプ ( database
、user
など) を決定するために使用できます。"id"
プロパティによってアドレス指定できます。ID を Notion URL からコピーする場合など、API にリクエストを行うときは、ID からダッシュを省略できます。2020-08-12T02:12:33.231Z
) が含まれますが、日付には日付のみが含まれます。 (2020-08-12
)url
Property value objectなどのプロパティの文字列値を設定解除するには、""
の代わりに明示的なnull
を使用します。コード サンプルと SDK
ページネーション
サポートされているエンドポイント
HTTP メソッド | 終点 |
---|---|
GET | すべてのユーザーを一覧表示する |
GET | ブロックの子を取得する |
GET | コメントを取得する |
GET | ページ プロパティ アイテムを取得する |
POST | データベースにクエリを実行する |
POST | 検索 |
レスポンス
分野 | タイプ | 説明 |
---|---|---|
has_more | boolean | レスポンスにリストの最後が含まれるかどうか。それ以上の結果がない場合false なり、そうでなければtrue になります。 |
next_cursor | string | 値をstart_cursor パラメータとして同じエンドポイントに渡すことで、結果の次のページを取得するために使用できる文字列。has_more が true の 場合にのみ使用できます。 |
object | "list" | 定数文字列"list" 。 |
results | array of objects | エンドポイント固有の結果のリストまたは部分的なリスト。詳細については、サポートされているエンドポイントの個別のドキュメントを参照してください。 |
type | "block" "comment" "database" "page" "page_or_database" "property_item" "user" | results 内のオブジェクトのタイプを表す定数文字列。 |
{type} | paginated list object | タイプ固有のページネーション情報を含むオブジェクト。property_item の場合 、値は 分割されたページ プロパティタイプに対応します。他のすべてのタイプの場合、値は空のオブジェクトです。 |
ページ分割されたリクエストのパラメータ
🚧パラメーターの場所はエンドポイントによって異なります
GET
リクエストは、クエリの文字列のパラメーターを受け入れます。POST
リクエストは、リクエストのBodyでパラメーターを受け取ります。
パラメータ | タイプ | 説明 |
---|---|---|
page_size | number | レスポンスに含める完全なリストからのアイテムの数。 デフォルト: 100 最大: 100 レスポンスに含まれる結果の数がデフォルトよりも少ない場合があります。 |
start_cursor | string | 以前のレスポンスで返されたnext_cursor 値。これを不透明な値として扱います。デフォルトは undefined で、リストの先頭から結果を返します。 |
ページ分割されたリクエストを送信する方法
1.
2.
next_cursor
値を取得します(has_more
がtrue
の場合のみ利用可能)。3.
GET
リクエストの場合) またはBodyパラメーター (POST
リクエスト)にnext_cursor
パラメーターを含むフォローアップ リクエストをエンドポイントに送信します。例: データベースから次の一連のクエリ結果をリクエストする
curl --location --request POST 'https://api.notion.com/v1/databases/<database_id>/query' \
--header 'Authorization: Bearer <secret_bot>' \
--header 'Content-Type: application/json' \
--data '{
"start_cursor": "33e19cb9-751f-4993-b74d-234d67d0d534"
}'
更新日時 2023-04-27 09:35:05