Method: notes.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Listet Notizen auf.
Jeder Listenaufruf gibt eine Seite mit Ergebnissen zurück, wobei pageSize die Obergrenze der zurückgegebenen Elemente ist. Bei einem pageSize von null kann der Server die Obergrenze auswählen.
Die ListNotesResponse enthält höchstens pageSize Einträge. Wenn noch weitere Elemente aufgeführt werden müssen, wird der Wert nextPageToken zurückgegeben. Seiten-Token sind nicht transparente Werte.
Wenn Sie die nächste Ergebnisseite abrufen möchten, kopieren Sie das nextPageToken des Ergebnisses in das pageToken der nächsten Anfrage. Wiederholen Sie den Vorgang, bis das nextPageToken, das mit einer Ergebnisseite zurückgegeben wird, leer ist.
notes.list gibt bei gleichzeitigen Änderungen konsistente Ergebnisse zurück oder signalisiert mit einem ABORTED-Fehler, dass dies nicht möglich ist.
HTTP-Anfrage
GET https://keep.googleapis.com/v1/notes
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
| Parameter |
pageSize |
integer
Die maximale Anzahl von zurückzugebenden Ergebnissen.
|
pageToken |
string
Das Feld nextPageToken der vorherigen Seite.
|
filter |
string
Filtern Sie nach Listenergebnissen. Wenn kein Filter angegeben ist, wird standardmäßig der Filter trashed angewendet. Gültige Felder, nach denen gefiltert werden kann, sind createTime, updateTime, trashTime und trashed. Die Filtersyntax folgt der Google AIP-Filter-Spezifikation.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Die Antwort, wenn eine Notizseite aufgelistet wird.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
| JSON-Darstellung |
{
"notes": [
{
object (Note)
}
],
"nextPageToken": string
} |
| Felder |
notes[] |
object (Note)
Eine Seite mit Notizen.
|
nextPageToken |
string
Das Feld pageToken der nächsten Seite.
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/keephttps://www.googleapis.com/auth/keep.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],[],null,["# Method: notes.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListNotesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nLists notes.\n\nEvery list call returns a page of results with `pageSize` as the upper bound of returned items. A `pageSize` of zero allows the server to choose the upper bound.\n\nThe ListNotesResponse contains at most `pageSize` entries. If there are more things left to list, it provides a `nextPageToken` value. (Page tokens are opaque values.)\n\nTo get the next page of results, copy the result's `nextPageToken` into the next request's `pageToken`. Repeat until the `nextPageToken` returned with a page of results is empty.\n\nnotes.list return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.\n\n### HTTP request\n\n`GET https://keep.googleapis.com/v1/notes`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of results to return. |\n| `pageToken` | `string` The previous page's `nextPageToken` field. |\n| `filter` | `string` Filter for list results. If no filter is supplied, the `trashed` filter is applied by default. Valid fields to filter by are: `createTime`, `updateTime`, `trashTime`, and `trashed`. Filter syntax follows the [Google AIP filtering spec](https://aip.dev/160). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response when listing a page of notes.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------|\n| ``` { \"notes\": [ { object (/workspace/keep/api/reference/rest/v1/notes#Note) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------|\n| `notes[]` | `object (`[Note](/workspace/keep/api/reference/rest/v1/notes#Note)`)` A page of notes. |\n| `nextPageToken` | `string` Next page's `pageToken` field. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/keep`\n- `https://www.googleapis.com/auth/keep.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
