Shortcuts Data Model

This guide outlines structure of the various data objects that you can access via Shortcuts.


List

  • List – The actual List object. Useful for passing into the Open List shortcut
  • Title – Title of the list
  • Date Added – Date the list was created
  • Date Edited – Date the list was last edited
  • Deeplink – A url that links directly to the List
  • Items – An array of List Item objects within the List

List Item

  • List Item – The actual List Item object. Useful for passing into the Open List Item shortcut.
  • Title – Title of the item
  • Item Type – The data type for the item: app, book, movie, etc
  • Image URL – The URL for the item’s cover image
  • Date Added – Date the item was added
  • Date Edited – Date the item was lasted edited
  • Sticky Note – The contents of the item’s Sticky Note, if it has one
  • On Shelf – A Bool indicating if the item is on The Shelf (True or False)
  • List – The List object in which the item is within
  • Deeplink – A url that links directly to the List Item

Activity Item

  • Activity Item – The actual Activity Item object. Useful for passing into the Open Activity Item shortcut.
  • Title – Title of the item
  • Item Type – The data type for the item: app, book, movie, etc
  • Image URL – The URL for the item’s cover image
  • Date Added – Date the item was added
  • Date Edited – Date the item was lasted edited
  • Sticky Note – The contents of the item’s Sticky Note, if it has one
  • Deeplink – A url that links directly to the Activity Item

Join the Community

Get help, ask questions, and see how other people are using Sofa