APIHub
Back to Explore

Google Keep

The Google Keep API provides REST endpoints to create, retrieve, list, and delete Keep notes, download note attachments, and batch‑manage note permissions.

Development
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

401ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1/notes

Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.

  • filter (query) — Filter for list results. If no filter is supplied, the `trashed` filter is applied by default. Valid fields to filter by are: `create_time`, `update_time`, `trash_time`, and `trashed`. Filter syntax follows the [Google AIP filtering spec](https://aip.dev/160).
  • pageSize (query, limit) — The maximum number of results to return.
  • pageToken (query) — The previous page's `next_page_token` field.
POST

/v1/notes

Creates a new note.

DELETE

/v1/{name}

Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.

  • name (path, required) — Required. Name of the note to delete.
GET

/v1/{name}

Gets a note.

  • name (path, required) — Required. Name of the resource.
  • mimeType (query) — The IANA MIME type format requested. The requested MIME type must be one specified in the attachment.mime_type. Required when downloading attachment media and ignored otherwise.
POST

/v1/{parent}/permissions:batchCreate

Creates one or more permissions on the note. Only permissions with the `WRITER` role may be created. If adding any permission fails, then the entire request fails and no changes are made.

  • parent (path, required) — The parent resource shared by all Permissions being created. Format: `notes/{note}` If this is set, the parent field in the CreatePermission messages must either be empty or match this field.
POST

/v1/{parent}/permissions:batchDelete

Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.

  • parent (path, required) — The parent resource shared by all permissions being deleted. Format: `notes/{note}` If this is set, the parent of all of the permissions specified in the DeletePermissionRequest messages must match this field.

6 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://developers.google.com/keep/api/reference/rest/v1/notes"

developers.google.com · HTTPS only