Jump to Content
Snowpal
GuidesRecipesAPI ReferenceChangelogDiscussions
v1.0.4

API ReferenceSnowpal
API Reference
API Reference
LaraGuidesRecipesAPI ReferenceChangelogDiscussions
All
Pages
Start typing to search…

Snowpal: Building Blocks API

  • Dashboard.1
    • Dashboard.1.1: Get dashboard detailsget
    • Dashboard.1.2: Get recently modified blocks and podsget
    • Dashboard.1.3: Get unread countget
    • Dashboard.1.4: Get recently modified keysget
    • Dashboard.1.5: Get pods and tasks due shortlyget
    • Dashboard.1.6: Get blocks due shortlyget
    • Dashboard.1.7: Get unread notificationsget
    • Dashboard.1.8: Get unread conversationsget
  • Dashboard.2: Charts
    • Dashboard.2.1: Get user keys, blocks and podsget
    • Dashboard.2.2: Get system keys, blocks and podsget
    • Dashboard.2.3: Get filtered user keys, blocks and pods.get
    • Dashboard.2.4: Get filtered system keys, blocks and pods.get
    • Dashboard.2.5: Get blocks based on block typesget
    • Dashboard.2.6: Get pods based on pod typesget
    • Dashboard.2.7: Get blocks and pods based on scalesget
    • Dashboard.2.8: Get tasks by statusget
  • Keys.1
    • Keys.1.1: Get keysget
    • Keys.1.2: Add keypost
    • Keys.1.3: Add key (based on template)post
    • Keys.1.4: Get keyget
    • Keys.1.5: Update keypatch
    • Keys.1.6: Get archived keysget
    • Keys.1.7: Get keys a pod is linked toget
    • Keys.1.8: Get keys a block is linked toget
    • Keys.1.9: Get keys filtered by typeget
    • Keys.1.10: Bulk archive keyspatch
    • Keys.1.11: Archive keypatch
    • Keys.1.12: Unarchive keypatch
    • Keys.1.13: Update key descriptionpatch
  • Keys.2: Charts
    • Keys.2.1: Get blocks and pods associated with keyget
    • Keys.2.2: Get filtered user keys, blocks and pods for given key.get
    • Keys.2.3: Get block types and blocks based on them (in key)get
    • Keys.2.4: Get pods based on pod types (in key)get
    • Keys.2.5: Get scales along with blocks and pods based on themget
    • Keys.2.6: Get linked resourcesget
    • Keys.2.7: Get key pod and block scale valuesget
    • Keys.2.8: Get task statusget
  • Keys.3: Checklists
    • Keys.3.1: Get key checklistsget
    • Keys.3.2: Add key checklistpost
    • Keys.3.3: Reorder key checklistspatch
    • Keys.3.4: Rename key checklistpatch
    • Keys.3.5: Delete key checklistdel
    • Keys.3.6: Add key checklist itempost
    • Keys.3.7: Update key checklist itempatch
    • Keys.3.8: Delete key checklist itemdel
    • Keys.3.9: Reorder key checklist itemspatch
  • Keys.4: Notes
    • Keys.4.1: Get key notesget
    • Keys.4.2: Add key notepost
    • Keys.4.3: Update key notepatch
    • Keys.4.4: Delete key notedel
  • Keys.5: Tasks
    • Keys.5.1: Get key tasksget
    • Keys.5.2: Add key taskpost
    • Keys.5.3: Update key taskpatch
    • Keys.5.4: Delete key taskdel
    • Keys.5.5: Reorder key taskspatch
  • Key Pods.1
    • Key Pods.1.1: Get key podsget
    • Key Pods.1.2: Add key podpost
    • Key Pods.1.3: Add key pod (based on template)post
    • Key Pods.1.4: Get pods available to be linked to this keyget
    • Key Pods.1.5: Link key pod to keypatch
    • Key Pods.1.6: Unlink key pod from keypatch
    • Key Pods.1.7: Get key podget
    • Key Pods.1.8: Update key podpatch
    • Key Pods.1.9: Update key pod completion statuspatch
    • Key Pods.1.10: Update key pod scale valuepatch
    • Key Pods.1.11: Add pod type to key pod.patch
    • Key Pods.1.12: Delete pod type from key podpatch
    • Key Pods.1.13: Add scale to key podpatch
    • Key Pods.1.14: Delete scale from key podpatch
    • Key Pods.1.15: Archive key podpatch
    • Key Pods.1.16: Get archived key podsget
    • Key Pods.1.17: Unarchive key podpatch
    • Key Pods.1.18: Bulk archive key podspatch
    • Key Pods.1.19: Update key pod descriptionpatch
    • Key Pods.1.20: Allow archival of key podpatch
    • Key Pods.1.21: Copy key podpost
    • Key Pods.1.22: Move key podpatch
  • Key Pods.2: Attachments
    • Key Pods.2.1: Get key pod attachmentsget
    • Key Pods.2.2: Add key pod attachmentpatch
    • Key Pods.2.3: Rename key pod attachmentpatch
    • Key Pods.2.4: Delete key pod attachmentdel
  • Key Pods.3: Checklists
    • Key Pods.3.1: Get key pod checklistsget
    • Key Pods.3.2: Add key pod checklistpost
    • Key Pods.3.3: Reorder key pod checklistspatch
    • Key Pods.3.4: Delete key pod checklistdel
    • Key Pods.3.5: Rename key pod checklistpatch
    • Key Pods.3.6: Add key pod checklist itempost
    • Key Pods.3.7: Update key pod checklist itempatch
    • Key Pods.3.8: Delete key pod checklist itemdel
    • Key Pods.3.9: Reorder key pod checklist itemspatch
  • Key Pods.4: Comments
    • Key Pods.4.1: Get key pod commentsget
    • Key Pods.4.2: Add key pod commentpost
    • Key Pods.4.3: Update key pod commentpatch
    • Key Pods.4.4: Delete key pod commentdel
  • Key Pods.5: Notes
    • Key Pods.5.1: Get key pod notesget
    • Key Pods.5.2: Add key pod notepost
    • Key Pods.5.3: Update key pod notepatch
    • Key Pods.5.4: Delete key pod notedel
  • Key Pods.6: Tasks
    • Key Pods.6.1: Get key pod tasksget
    • Key Pods.6.2: Add key pod taskpost
    • Key Pods.6.3: Update key pod taskpatch
    • Key Pods.6.4: Delete key pod taskdel
    • Key Pods.6.5: Assign key pod taskpatch
    • Key Pods.6.6: Unassign key pod taskpatch
    • Key Pods.6.7: Reorder key pod taskspatch
  • Blocks.1
    • Blocks.1.1: Get blocksget
    • Blocks.1.2: Add blockpost
    • Blocks.1.3: Get blocks linked to podget
    • Blocks.1.4: Add block (based on template)post
    • Blocks.1.5: Link block to keypatch
    • Blocks.1.6: Unlink block from keypatch
    • Blocks.1.7: Get blocks available to be linked to this keyget
    • Blocks.1.8: Get blockget
    • Blocks.1.9: Update blockpatch
    • Blocks.1.10: Add block type to blockpatch
    • Blocks.1.11: Delete block type from blockpatch
    • Blocks.1.12: Add scale to blockpatch
    • Blocks.1.13: Delete scale from blockpatch
    • Blocks.1.14: Update block scale valuepatch
    • Blocks.1.15: Update block descriptionpatch
    • Blocks.1.16: Archive blockpatch
    • Blocks.1.17: Unarchive blockpatch
    • Blocks.1.18: Get archived blocksget
    • Blocks.1.19: Bulk archive blockspatch
    • Blocks.1.20: Allow archival of blockpatch
    • Blocks.1.21: Copy blockpost
    • Blocks.1.22: Move blockpatch
  • Blocks.2: Attachments
    • Blocks.2.1: Get block attachmentsget
    • Blocks.2.2: Add block attachmentpatch
    • Blocks.2.3: Rename block attachmentpatch
    • Blocks.2.4: Delete block attachmentdel
  • Blocks.3: Charts
    • Blocks.3.1: Get linked block podsget
    • Blocks.3.2: Get scale values for scaleget
    • Blocks.3.3: Get task status for blockget
    • Blocks.3.4: Get block grades for all studentsget
  • Blocks.4: Checklists
    • Blocks.4.1: Get block checklistsget
    • Blocks.4.2: Add block checklistpost
    • Blocks.4.3: Reorder block checklistspatch
    • Blocks.4.4: Rename block checklistpatch
    • Blocks.4.5: Delete block checklistdel
    • Blocks.4.6: Add block checklist itempost
    • Blocks.4.7: Update block checklist itempatch
    • Blocks.4.8: Delete block checklist itemdel
    • Blocks.4.9: Reorder block checklist itemspatch
  • Blocks.5: Comments
    • Blocks.5.1: Get block commentsget
    • Blocks.5.2: Add block commentpost
    • Blocks.5.3: Update block commentpatch
    • Blocks.5.4: Delete block commentdel
  • Blocks.6: Notes
    • Blocks.6.1: Get block notesget
    • Blocks.6.2: Add block notepost
    • Blocks.6.3: Update block notepatch
    • Blocks.6.4: Delete block notedel
  • Blocks.7: Tasks
    • Blocks.7.1: Get block tasksget
    • Blocks.7.2: Add block taskpost
    • Blocks.7.3: Update block taskpatch
    • Blocks.7.4: Delete block taskdel
    • Blocks.7.5: Assign block taskpatch
    • Blocks.7.6: Unassign block taskpatch
    • Blocks.7.7: Reorder block taskspatch
  • Block Pods.1
    • Block Pods.1.1: Get block podsget
    • Block Pods.1.2: Add block podpost
    • Block Pods.1.3: Add block pod (based on template)post
    • Block Pods.1.4: Link pod to blockpatch
    • Block Pods.1.5: Unlink pod from blockpatch
    • Block Pods.1.6: Get block podget
    • Block Pods.1.7: Update block podpatch
    • Block Pods.1.8: Update block pod completion statuspatch
    • Block Pods.1.9: Add pod type to block podpatch
    • Block Pods.1.10: Delete pod type from block podpatch
    • Block Pods.1.11: Add scale to block podpatch
    • Block Pods.1.12: Delete scale from block podpatch
    • Block Pods.1.13: Update block pod scale valuepatch
    • Block Pods.1.14: Archive block podpatch
    • Block Pods.1.15: Get archived block podsget
    • Block Pods.1.16: Get pods available to be linked to this blockget
    • Block Pods.1.17: Unarchive block podpatch
    • Block Pods.1.18: Bulk archive block podspatch
    • Block Pods.1.19: Update block pod descriptionpatch
    • Block Pods.1.20: Allow archival of block podpatch
    • Block Pods.1.21: Copy block podpost
    • Block Pods.1.22: Move block podpatch
  • Block Pods.2: Attachments
    • Block Pods.2.1: Get block pod attachmentsget
    • Block Pods.2.2: Add block pod attachmentpatch
    • Block Pods.2.3: Rename block pod attachmentpatch
    • Block Pods.2.4: Delete block pod attachmentdel
  • Block Pods.3: Charts
    • Block Pods.3.1: Get block pod tasks (for Charts)get
    • Block Pods.3.2: Get block pod grades for all studentsget
  • Block Pods.4: Checklists
    • Block Pods.4.1: Get block pod checklistsget
    • Block Pods.4.2: Add block pod checklistpost
    • Block Pods.4.3: Reorder block pod checklistspatch
    • Block Pods.4.4: Delete block pod checklistdel
    • Block Pods.4.5: Rename block pod checklistpatch
    • Block Pods.4.6: Add block pod checklist itempost
    • Block Pods.4.7: Update block pod checklist itempatch
    • Block Pods.4.8: Delete block pod checklist itemdel
    • Block Pods.4.9: Reorder block pod checklist itemspatch
  • Block Pods.5: Comments
    • Block Pods.5.1: Get block pod commentsget
    • Block Pods.5.2: Add block pod commentpost
    • Block Pods.5.3: Update block pod commentpatch
    • Block Pods.5.4: Delete block pod commentdel
  • Block Pods.6: Notes
    • Block Pods.6.1: Get block pod notesget
    • Block Pods.6.2: Add block pod notepost
    • Block Pods.6.3: Update block pod notepatch
    • Block Pods.6.4: Delete block pod notedel
  • Block Pods.7: Tasks
    • Block Pods.7.1: Get block pod tasksget
    • Block Pods.7.2: Add block pod taskpost
    • Block Pods.7.3: Update block pod taskpatch
    • Block Pods.7.4: Delete block pod taskdel
    • Block Pods.7.5: Assign block pod taskpatch
    • Block Pods.7.6: Unassign block pod taskpatch
    • Block Pods.7.7: Reorder block pod taskspatch
  • Collaboration.1: Blocks
    • Collaboration.1.1: Get block collaboratorsget
    • Collaboration.1.2: Update block ACLpatch
    • Collaboration.1.3: Unshare block from collaboratorpatch
    • Collaboration.1.4: Share block with collaboratorpatch
    • Collaboration.1.5: Share block with collaborator (along with pods)patch
    • Collaboration.1.6: Get users this block can be shared withget
    • Collaboration.1.7: Bulk share blocks with collaboratorspatch
    • Collaboration.1.8: Leave blockpatch
  • Collaboration.2: Block Pods
    • Collaboration.2.1: Get block pod collaboratorsget
    • Collaboration.2.2: Share block pod with collaboratorpatch
    • Collaboration.2.3: Unshare block pod from collaboratorpatch
    • Collaboration.2.4: Bulk share block pods with collaboratorspatch
    • Collaboration.2.5: Get users this block pod can be shared withget
    • Collaboration.2.6: Update block pod ACLpatch
    • Collaboration.2.7: Leave block podpatch
  • Collaboration.3: Key Pods
    • Collaboration.3.1: Get key pod collaboratorsget
    • Collaboration.3.2: Share key pod with collaboratorpatch
    • Collaboration.3.3: Bulk share key pods with collaboratorspatch
    • Collaboration.3.4: Unshare key pod from collaboratorpatch
    • Collaboration.3.5: Get users this key pod can be shared withget
    • Collaboration.3.6: Update key pod ACLpatch
    • Collaboration.3.7: Leave key podpatch
  • Project Keys.1
    • Project Keys.1.1: Add a project podpost
    • Project Keys.1.2: Add project pod (based on template)post
    • Project Keys.1.3: Link project pod to blockpatch
    • Project Keys.1.4: Reorder project podspatch
    • Project Keys.1.5: Copy project podpost
    • Project Keys.1.6: Move project podpatch
    • Project Keys.1.7: Assign project podpatch
    • Project Keys.1.8: Unassign project podpatch
  • Project Keys.2: Lists
    • Project Keys.2.1: Add project block listpost
    • Project Keys.2.2: Get project listsget
    • Project Keys.2.3: Copy all pods in project listpost
    • Project Keys.2.4: Bulk copy pods in project listpost
    • Project Keys.2.5: Move all pods in project listpatch
    • Project Keys.2.6: Bulk move pods in project listpatch
    • Project Keys.2.7: Move project listpatch
    • Project Keys.2.8: Get project listget
    • Project Keys.2.9: Rename project listpatch
    • Project Keys.2.10: Reorder project listpatch
    • Project Keys.2.11: Archive project listpatch
  • Teacher Keys.1: Students
    • Teacher Keys.1.1: Get attachment submissions (as student)get
    • Teacher Keys.1.2: Get comment submissions (as student)get
    • Teacher Keys.1.3: Get students in a blockget
  • Teacher Keys.2: Teachers
    • Teacher Keys.2.1: Get student attachment submissions (as teacher)get
    • Teacher Keys.2.2: Get student comment submissions (as teacher)get
    • Teacher Keys.2.3: Add attachment to teacher pod (as teacher)post
    • Teacher Keys.2.4: Add comment to teacher pod (as teacher)post
    • Teacher Keys.2.5: Get block and pods' grades for a student (as teacher)get
    • Teacher Keys.2.6: Publish student grades for a blockpatch
    • Teacher Keys.2.7: Bulk publish pod grades for a studentpatch
    • Teacher Keys.2.8: Bulk publish pod grades for studentspatch
    • Teacher Keys.2.9: Get block grades for all studentsget
    • Teacher Keys.2.10: Get pod grades for all studentsget
    • Teacher Keys.2.11: Assign grade to studentpatch
    • Teacher Keys.2.12: Assign pod grade for a student (as teacher)patch
    • Teacher Keys.2.13: Get student profileget
  • Attributes.1
    • Attributes.1.1: Get displayable attributes of Key, Block and Podget
    • Attributes.1.2: Update key display attributespatch
    • Attributes.1.3: Update block display attributespatch
    • Attributes.1.4: Update key pod display attributespatch
    • Attributes.1.5: Update block pod display attributespatch
  • Block Types.1
    • Block Types.1.1: Get block typesget
    • Block Types.1.2: Add block typepost
    • Block Types.1.3: Update block typepatch
    • Block Types.1.4: Delete block typedel
    • Block Types.1.5: Get blocks using block typeget
  • Comments.1
    • Comments.1.1: Get recent commentsget
  • Conversations.1
    • Conversations.1.1: Get unread conversations countget
    • Conversations.1.2: Get user conversationsget
    • Conversations.1.3: Add private or group conversationpost
    • Conversations.1.4: Get conversation for given usernamesget
    • Conversations.1.5: Send message to an existing conversationpatch
    • Conversations.1.6: Get conversationget
    • Conversations.1.7: Delete conversationdel
    • Conversations.1.8: Leave conversationpatch
    • Conversations.1.9: Archive conversationpatch
  • Favorites.1
    • Favorites.1.1: Get favoritesget
    • Favorites.1.2: Add key as favoritepost
    • Favorites.1.3: Add block as favoritepost
    • Favorites.1.4: Add pod as favoritepost
    • Favorites.1.5: Add block pod as favoritepost
    • Favorites.1.6: Delete favoritedel
  • Followers.1
    • Followers.1.1: Add user to `Follow Us` listpatch
    • Followers.1.2: Get Followersget
  • Notifications.1
    • Notifications.1.1: Get notificationsget
    • Notifications.1.2: Get unread notificationsget
    • Notifications.1.3: Get unread notification countget
    • Notifications.1.4: Mark notification as readpatch
    • Notifications.1.5: Mark notifications as read (in bulk)patch
  • Pod Types.1
    • Pod Types.1.1: Get pod typesget
    • Pod Types.1.2: Add pod typepost
    • Pod Types.1.3: Update pod typepatch
    • Pod Types.1.4: Delete pod typedel
    • Pod Types.1.5: Get pods using pod typeget
  • Profile.1
    • Profile.1.1: Get user profileget
    • Profile.1.2: Update user's profilepatch
    • Profile.1.3: Update usernamepatch
    • Profile.1.4: Blocks user from sending messagespatch
    • Profile.1.5: Unblocks userpatch
  • Registration.1
    • Registration.1.1: Register new user by emailpost
    • Registration.1.2: Sign in by emailpost
    • Registration.1.3: Reset passwordpatch
    • Registration.1.4: Activate userpatch
  • Relations.1
    • Relations.1.1: Get relations matching search tokenget
    • Relations.1.2: Get relations for keyget
    • Relations.1.3: Get relations for blockget
    • Relations.1.4: Get relations for podget
    • Relations.1.5: Get relations for block podget
    • Relations.1.6: Relate key to keypatch
    • Relations.1.7: Unrelate key from keypatch
    • Relations.1.8: Relate block to keypatch
    • Relations.1.9: Unrelate block from keypatch
    • Relations.1.10: Relate pod to keypatch
    • Relations.1.11: Unrelate pod from keypatch
    • Relations.1.12: Relate pod to blockpatch
    • Relations.1.13: Unrelate pod from blockpatch
    • Relations.1.14: Relate block to blockpatch
    • Relations.1.15: Unrelate block from blockpatch
    • Relations.1.16: Relate pod to podpatch
    • Relations.1.17: Unrelate pod from podpatch
  • Scales.1
    • Scales.1.1: Get scalesget
    • Scales.1.2: Add scalepost
    • Scales.1.3: Get scaleget
    • Scales.1.4: Update scalepatch
    • Scales.1.5: Delete scaledel
    • Scales.1.6: Get blocks using scaleget
    • Scales.1.7: Get pods using scaleget
  • Scheduler.1
    • Scheduler.1.1: Get events in given windowget
    • Scheduler.1.2: Get events for given dayget
    • Scheduler.1.3: Get standalone eventsget
    • Scheduler.1.4: Add standalone eventpost
    • Scheduler.1.5: Update standalone eventpatch
    • Scheduler.1.6: Delete standalone eventdel
  • Search.1
    • Search.1.1: Search key, block or pod by tokenget
    • Search.1.2: Search user by tokenget
  • Templates.1
    • Templates.1.1: Get key templatesget
    • Templates.1.2: Get block templatesget
    • Templates.1.3: Get pod templatesget
  • User.1
    • User.1.1: Get usersget
    • User.1.2: Get user by UUIDget
    • User.1.3: Get user by Emailget
    • User.1.4: Deactivate user accountpatch
    • User.1.5: Delete user accountpatch
  • Version.1
    • Version.1.1: Get latest versionget
    • Version.1.2: Get app statusget

Project Management API

  • Build Integrations using our Project Management API
    • Example apps using this API

Content Management API

  • Extensible Content Management
    • Example apps using this API

Conversation API

  • Personal and Group Conversations
    • Example apps using this API

Classroom API

  • Classroom: Teacher and Student Services
    • Example apps using this API

Status API

  • Status Management
Powered by 
  1. Conversation API
  2. Personal and Group Conversations

Example apps using this API

These apps have been in production for years.