v62

latestOpenAPI 3.0.3raw.githubusercontent.com2026-07-31136116265.6 KB
device

For .qi files, returns the queued up notes. For .db files, returns all notes in the notefile

get/v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}

Path parameters

projectOrProductUIDstring required
deviceUIDstring required
notefileIDstring required

Query parameters

maxinteger

The maximum number of Notes to return in the request.

deletedboolean

true to return deleted notes.

deleteboolean

true to delete the notes returned by the request.

Response

The note changes object

changesinteger

The number of pending changes in the Notefile.

notesobject

An object with a key for each note and a value object with the body of each Note and the time the Note was added.

totalinteger

The total number of notes.