Sync API Docs

Sync API Docs

Main docs for Sync API users.

  • To use this API, assuming that sync target is available (user setup and ran synchronize on joplin client at least once)
  • Assuming that the library supports sync version 3 (latest sync version).
// upload (create new) items  
// input should be in js object & validated
items = [{
    title: "", 
    body: "",
    type_: 1
  }]
createItems(items)    

// update an item  
// allow updating a few fields: title, body,...
updatedItem = {
    title: "", 
    body: "",
  }
updateItem(itemId, updatedItem)  

// delete items
deleteItems(itemIds)  


// get single item from its ID
getItem(itemId)  

// get remote items' metadata (ids, updated_time,...) newer than timestamp (inclusive)
options = { timestamp: ... } // set timestamp to 0 to get all files
getItemsMetadata(options)