---
type: api
title: Get notes
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/v8/operation/operation-getnotes
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/v8/operation/operation-getnotes
products:
  - Kibana
---

# Get notes

- Server: `https://{kibana_url}`

## Paths

- `GET` `/api/note`
- `GET` `/s/{space_id}/api/note`

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Get all notes for a given document.

## Authentication

- Api key: `Authorization: <value>`
  These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: `Authorization: ApiKey base64AccessApiKey`
- Basic: `Authorization: Basic <credentials>`

## Query string parameters

- `documentIds` (union oneOf) — optional
  One of: `string[]` or `string`
- `savedObjectIds` (union oneOf) — optional
  One of: `string[]` or `string`
- `page` (string) — optional — nullable
- `perPage` (string) — optional — nullable
- `search` (string) — optional — nullable
- `sortField` (string) — optional — nullable
- `sortOrder` (string) — optional — nullable
- `filter` (string) — optional — nullable
- `createdByFilter` (string) — optional — nullable
- `associatedFilter` (enum) — optional
  Values: `all`, `document_only`, `saved_object_only`, `document_and_saved_object`, `orphan`

## Response

Indicates the requested notes were returned.

`application/json`

One of:
- **{ notes, totalCount }**
  - `notes` (object[])
    - `created` (number) — nullable
      The time the note was created, using a 13-digit Epoch timestamp.
    - `createdBy` (string) — nullable
      The user who created the note.
    - `updated` (number) — nullable
      The last time the note was updated, using a 13-digit Epoch timestamp
    - `updatedBy` (string) — nullable
      The user who last updated the note
    - `eventId` (string) — nullable
      The `_id` of the associated event for this note.
    - `note` (string) — nullable
      The text of the note
    - `timelineId` (string)
      The `savedObjectId` of the Timeline that this note is associated with
    - `noteId` (string)
      The `savedObjectId` of the note
    - `version` (string)
      The version of the note
  - `totalCount` (number)
- **object**
## Code examples

#### Console

```console
GET kbn:/api/note
```

#### curl

```curl
curl -X GET "${KIBANA_URL}/api/note" \
  -H "Authorization: ApiKey ${API_KEY}"
```