notes

Read a note by filename

Exact filename first, then exact title as a fallback; a title shared by several notes is 422. Takes the same tail and since as GET /notes/{id}.

get/notes/by-filename/{filename}

Request

  • Base URL: https://freshjots.com/api/v1
  • URL: https://freshjots.com/api/v1/notes/by-filename/{filename}
  • Auth: HTTP bearer

Path parameters

filenamestring required

Exact filename (no slash).

Query parameters

tailinteger

Only the N most recent lines (1 to 10000).

sinceinteger

The byte_size from your last read; returns only what was appended after it. A value above the current size returns the whole body (resync).

Response

The note, whole or sliced.

idinteger required
hashidstring required
filenamestring required
titlestring nullable
format'plain' | 'rich' required
folder_idinteger nullable
pinnedboolean
append_onlyboolean required
client_encryptedboolean required
append_deadline_hoursinteger nullable
alert_emailstring nullable
match_patternstring nullable
match_alerted_atstring date-time nullable
last_appended_atstring date-time nullable
alerted_atstring date-time nullable
webhook_urlstring nullable
webhook_format'generic' | 'slack' | 'discord' | 'google_chat' | 'mattermost' | 'rocket_chat'
webhook_failure_countinteger
webhook_disabled_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
plain_bodystring required

The body, or the requested slice of it; for rich notes the plain-text projection.

byte_sizeinteger required

Full body size in bytes, even when sliced.

Changes

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