Method: notes.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Enumera las notas.
Cada llamada a la lista muestra una página de resultados con pageSize como límite superior de los elementos que se muestran. Un pageSize de cero permite que el servidor elija el límite superior.
ListNotesResponse contiene como máximo pageSize entradas. Si queda más información para enumerar, proporciona un valor nextPageToken. (Los tokens de página son valores opacos).
Para obtener la siguiente página de resultados, copia el nextPageToken del resultado en el pageToken de la siguiente solicitud. Repite el proceso hasta que el nextPageToken que se muestra con una página de resultados esté vacío.
notes.list muestra resultados coherentes ante cambios simultáneos o indica que no puede hacerlo con un error ABORTED.
Solicitud HTTP
GET https://keep.googleapis.com/v1/notes
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
| Parámetros |
pageSize |
integer
La cantidad máxima de resultados que se mostrarán.
|
pageToken |
string
El campo nextPageToken de la página anterior.
|
filter |
string
Filtra los resultados de la lista. Si no se proporciona ningún filtro, se aplica el filtro trashed de forma predeterminada. Los campos válidos para filtrar son createTime, updateTime, trashTime y trashed. La sintaxis de filtro sigue la especificación de filtrado de Google AIP.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Es la respuesta cuando se muestra una página de notas.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
| Representación JSON |
{
"notes": [
{
object (Note)
}
],
"nextPageToken": string
} |
| Campos |
notes[] |
object (Note)
Una página de notas
|
nextPageToken |
string
Campo pageToken de la página siguiente
|
Permisos de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/keephttps://www.googleapis.com/auth/keep.readonly
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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)."]]
