User Notes

Get a single note for the current user (or team note if accessible)

get/notes/{noteId}

Request

  • Base URL: https://api.hackmd.io/v1
  • URL: https://api.hackmd.io/v1/notes/{noteId}
  • Auth: HTTP bearer

Path parameters

noteIdstring required

The ID of the note to retrieve.

Headers

If-None-Matchstring

Return 304 when this ETag matches the current note.

Response

writePermission'owner' | 'signed_in' | 'guest' required
readPermission'owner' | 'signed_in' | 'guest' required
shortIdstring required
publishLinkstring required
permalinkstring nullable required
teamPathstring nullable required
userPathstring nullable required
publishedAtnumber double nullable required
publishType'edit' | 'view' | 'slide' | 'book' required
tagsUpdatedAtnumber double nullable required
titleUpdatedAtnumber double nullable required
createdAtnumber double required
lastChangedAtnumber double required
descriptionstring required
tagsstring[] required
titlestring required
idstring required
contentstring required

Changes

No recorded changes to this operation across all 1 revision of this API.