Method: notes.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Répertorie les notes.
Chaque appel de liste renvoie une page de résultats avec pageSize comme limite supérieure des éléments renvoyés. Une valeur pageSize de zéro permet au serveur de choisir la limite supérieure.
ListNotesResponse contient au maximum pageSize entrées. Si d'autres éléments doivent être listés, une valeur nextPageToken est fournie. (Les jetons de page sont des valeurs opaques.)
Pour obtenir la page de résultats suivante, copiez le nextPageToken du résultat dans le pageToken de la requête suivante. Répétez l'opération jusqu'à ce que l'nextPageToken renvoyé avec une page de résultats soit vide.
notes.list renvoie des résultats cohérents en cas de modifications simultanées, ou indique qu'il ne peut pas le faire avec une erreur ABORTED.
Requête HTTP
GET https://keep.googleapis.com/v1/notes
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
| Paramètres |
pageSize |
integer
Nombre maximal de résultats à renvoyer.
|
pageToken |
string
Champ nextPageToken de la page précédente.
|
filter |
string
Filtrez les résultats de la liste. Si aucun filtre n'est fourni, le filtre trashed est appliqué par défaut. Les champs valides sur lesquels filtrer sont les suivants: createTime, updateTime, trashTime et trashed. La syntaxe des filtres suit la spécification de filtrage Google AIP.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse lors de la liste d'une page de notes.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"notes": [
{
object (Note)
}
],
"nextPageToken": string
} |
| Champs |
notes[] |
object (Note)
Page de notes.
|
nextPageToken |
string
Champ pageToken de la page suivante.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/keephttps://www.googleapis.com/auth/keep.readonly
Pour en savoir plus, consultez le guide d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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)."]]
