コンテンツにスキップ

一覧¶

POST /api/v1/notes_v2/list

概要¶

現在のAPIキーが所属するアカウントから参照可能な新しいノートを一覧表示します。

Body リクエストパラメータ¶

パラメータ名	型	必須	説明
pageIndex	integer		ページ番号空を許可: False
pageSize	integer		1ページあたりの件数空を許可: False
search	string		タイトルと本文の検索語空を許可: False
query	string		タイトルと本文の検索語（search より優先度が高い）空を許可: False
tags	array		グローバルタグフィルター。複数タグを指定した場合、デフォルトでOR条件になります空を許可: False
tagKV	json		キー値タグフィルター。例: {"host":"127.0.0.1"} 空を許可: False
tagKVQuery	string		キー値タグ式フィルター。例: host:"127.0.0.1" 空を許可: False
tagMode	string		タグ一致方式。指定しない場合、tags はデフォルトでOR条件になります空を許可: False 選択可能な値: ['and', 'or']
createdSource	string		作成元フィルター。例: manual または ai 空を許可: False
noteType	string		ノートタイプフィルター。normal は通常のノート、runbook は操作手順書空を許可: False 選択可能な値: ['normal', 'runbook']
isPublic	boolean		公開ノートまたはプライベートノートのみを返すかどうか。Status Page の場合は必ず true を指定してください空を許可: False
tagKVRange	json		TagKV 文字列閉区間フィルター。例: {"date":{"gte":"2026-05-03","lte":"2026-07-31"}} 空を許可: False
includeContent	boolean		リスト項目にマークダウンコンテンツを含めるかどうか。有効にする場合は、ページングを行い、pageSize は 100 以下にしてください空を許可: False

パラメータ補足説明¶

このインターフェースを使用して、現在のワークスペースで現在のAPIキーがアクセスできる新しいノートの概要を取得します。

ページングが必要な場合は、pageIndex と pageSize を同時に指定してください。
タイトルまたは本文で検索する場合は search を指定してください。query も指定できます。両方が存在する場合は query が優先されます。
タグでフィルタリングする場合は tags、tagKV、または tagKVQuery を指定してください。例：tagKVQuery: "host:\"127.0.0.1\""。tags に複数の値を指定し、tagMode を指定しない場合は OR 条件になります。
リスト応答にはマークダウン本文は含まれません。本文を読み取るには、詳細インターフェースを呼び出してください。
その後の取得、変更、削除はすべて応答の noteUUID を使用します。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/notes_v2/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"pageIndex":1,"pageSize":20,"isPublic":true,"includeContent":true,"tagKV":{"page_scope":"status_page","publish_status":"published"},"tagKVRange":{"date":{"gte":"2026-05-03","lte":"2026-07-31"}}}'

レスポンス¶

{
    "code": 200,
    "content": {
        "data": [
            {
                "noteUUID": "nbnote_xxx",
                "title": "A",
                "name": "A",
                "tags": [
                    "ops"
                ],
                "tagKV": {
                    "host": "127.0.0.1"
                },
                "isPublic": 1,
                "createdSource": "manual",
                "noteType": "normal",
                "etag": "etag_xxx",
                "version": 1,
                "createAt": 1782370000,
                "updateAt": 1782370100
            }
        ],
        "pageInfo": {
            "pageIndex": 1,
            "pageSize": 20,
            "totalCount": 1
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}