Method: notes.list

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

GET https://keep.googleapis.com/v1/notes

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

The maximum number of results to return.

pageToken

string

The previous page's nextPageToken field.

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.

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
}
Fields
notes[]

object (Note)

A page of notes.

nextPageToken

string

Next page's pageToken field.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/keep
  • https://www.googleapis.com/auth/keep.readonly

For more information, see the Authentication and authorization overview.