Get notes

GET /api/note
Api key auth Basic auth

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.

    Hide response attributes Show response attributes object
    • notes array[object] Required
      Hide notes attributes Show notes attributes object
      • created number | null

        The time the note was created, using a 13-digit Epoch timestamp.

      • createdBy string | null

        The user who created the note.

      • updated number | null

        The last time the note was updated, using a 13-digit Epoch timestamp

      • updatedBy string | null

        The user who last updated the note

      • eventId string | null

        The _id of the associated event for this note.

      • note string | null

        The text of the note

      • timelineId string Required

        The savedObjectId of the Timeline that this note is associated with

      • noteId string Required

        The savedObjectId of the note

      • version string Required

        The version of the note

    • totalCount number Required
GET /api/note 
curl \
 --request GET 'https://localhost:5601/api/note' \
 --header "Authorization: $API_KEY"