Method: notes.list

Stay organized with collections Save and categorize content based on your preferences.

Lists notes.

Every 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.

The ListNotesResponse contains at most pageSize entries. If there are more things left to list, it provides a nextPageToken value. (Page tokens are opaque values.)

To 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.

notes.list return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.

HTTP request


The URL uses gRPC Transcoding syntax.

Query parameters



The maximum number of results to return.



The previous page's nextPageToken field.



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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The response when listing a page of notes.

JSON representation
  "notes": [
      object (Note)
  "nextPageToken": string

object (Note)

A page of notes.



Next page's pageToken field.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authorization guide.