Get notes

Base URL: https://{kibana_url}

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

Auth

Get all notes for a given document.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

documentIds union string[] | string
savedObjectIds union string[] | string
page string nullable
perPage string nullable
search string nullable
sortField string nullable
sortOrder string nullable
filter string nullable
createdByFilter string nullable
associatedFilter enum: Values: all document_only saved_object_only document_and_saved_object orphan

Response

Indicates the requested notes were returned.

application/json

One of:

notes object[] required
totalCount number required

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/note

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{
  "notes": [
    {
      "created": 1587468588922,
      "createdBy": "casetester",
      "updated": 1741344876825,
      "updatedBy": "casetester",
      "eventId": "d3a1d35a3e84a81b2f8f3859e064c224cdee1b4bc",
      "note": "This is an example text",
      "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e",
      "noteId": "709f99c6-89b6-4953-9160-35945c8e174e",
      "version": "WzQ2LDFd"
    }
  ],
  "totalCount": 0
}

Generated from the API spec