Get notes

GET /api/note

Get all notes for a given document.

Query parameters

documentIds array[string] | string
savedObjectIds array[string] | string
page string | null
perPage string | null
search string | null
sortField string | null
sortOrder string | null
filter string | null
createdByFilter string | null
associatedFilter string

Filter notes based on their association with a document or saved object.

Values are all, document_only, saved_object_only, document_and_saved_object, or orphan.

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Indicates the requested notes were returned.
Hide response attributes Show response attributes object
- notes array[object] Required
  
  Hide notes attributes Show notes attributes object
  
  created number | null
  
  createdBy string | null
  
  eventId string | null
  
  note string | null
  
  timelineId string Required
  
  updated number | null
  
  updatedBy string | null
  
  noteId string Required
  
  version string Required
- totalCount number Required

GET /api/note

curl \
 -X GET https://localhost:5601/api/note

Response examples (200)

{
  "notes": [
    {
      "created": 42.0,
      "createdBy": "string",
      "eventId": "string",
      "note": "string",
      "timelineId": "string",
      "updated": 42.0,
      "updatedBy": "string",
      "noteId": "string",
      "version": "string"
    }
  ],
  "totalCount": 42.0
}