List¶

POST /api/v1/notes_v2/list

Overview¶

List the notes (new version) visible to the account that owns the current API Key.

Body Request Parameters¶

Parameter	Type	Description
pageIndex	integer	Page number Allow empty: False
pageSize	integer	Items per page Allow empty: False
search	string	Search term for title and body Allow empty: False
query	string	Search term for title and body; takes precedence over search Allow empty: False
tags	array	Global tag filter; when multiple tags are passed, they match by OR by default Allow empty: False
tagKV	json	Key-value tag filter, e.g., {"host":"127.0.0.1"} Allow empty: False
tagKVQuery	string	Key-value tag expression filter, e.g., host:"127.0.0.1" Allow empty: False
tagMode	string	Tag matching mode; when not passed, tags match by OR by default Allow empty: False Allowed values: ['and', 'or']
createdSource	string	Filter by creation source, e.g., manual or ai Allow empty: False
noteType	string	Filter by note type: normal for regular notes, runbook for runbooks, statuspages for status page notes Allow empty: False Allowed values: ['normal', 'runbook', 'statuspages']
isPublic	boolean	Whether to return only public or private notes; must always pass true for Status Page Allow empty: False
tagKVRange	json	TagKV string closed-interval filter, e.g., {"date":{"gte":"2026-05-03","lte":"2026-07-31"}} Allow empty: False
includeContent	boolean	Whether to return Markdown content in list items; when enabled, pagination is required and pageSize must not exceed 100 Allow empty: False

Additional Parameter Notes¶

Use this API to retrieve summaries of the notes (new version) accessible to the current API Key in the current workspace.

For pagination, pass both pageIndex and pageSize.
To search by title or body, pass search; you can also pass query. When both are present, query takes precedence.
To filter by tags, pass tags, tagKV, or tagKVQuery, e.g., tagKVQuery: "host:\"127.0.0.1\""; when multiple values are passed to tags without tagMode, they match by OR.
The list response does not include the Markdown body; call the detail API to read the body.
Use the noteUUID in the response for subsequent retrieval, modification, and deletion.

Request Example¶

curl 'https://openapi.truewatch.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"}}}'

Response¶

{
    "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"
}