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
  • 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

    Indicates the requested notes were returned.

    One of:
GET /api/note
curl \
 --request GET 'http://localhost:5601/api/note' \
 --header "Authorization: $API_KEY"