Jump to Content
Guides
Recipes
API Reference
Changelog
Discussions
v1.0.4
API Reference
API Reference
API Reference
Lara
Guides
Recipes
API Reference
Changelog
Discussions
Personal and Group Conversations
All
Pages
Start typing to search…
JUMP TO
Snowpal: Building Blocks API
Dashboard.1
Dashboard.1.1: Get dashboard details
get
Dashboard.1.2: Get recently modified blocks and pods
get
Dashboard.1.3: Get unread count
get
Dashboard.1.4: Get recently modified keys
get
Dashboard.1.5: Get pods and tasks due shortly
get
Dashboard.1.6: Get blocks due shortly
get
Dashboard.1.7: Get unread notifications
get
Dashboard.1.8: Get unread conversations
get
Dashboard.2: Charts
Dashboard.2.1: Get user keys, blocks and pods
get
Dashboard.2.2: Get system keys, blocks and pods
get
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 types
get
Dashboard.2.6: Get pods based on pod types
get
Dashboard.2.7: Get blocks and pods based on scales
get
Dashboard.2.8: Get tasks by status
get
Keys.1
Keys.1.1: Get keys
get
Keys.1.2: Add key
post
Keys.1.3: Add key (based on template)
post
Keys.1.4: Get key
get
Keys.1.5: Update key
patch
Keys.1.6: Get archived keys
get
Keys.1.7: Get keys a pod is linked to
get
Keys.1.8: Get keys a block is linked to
get
Keys.1.9: Get keys filtered by type
get
Keys.1.10: Bulk archive keys
patch
Keys.1.11: Archive key
patch
Keys.1.12: Unarchive key
patch
Keys.1.13: Update key description
patch
Keys.2: Charts
Keys.2.1: Get blocks and pods associated with key
get
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 them
get
Keys.2.6: Get linked resources
get
Keys.2.7: Get key pod and block scale values
get
Keys.2.8: Get task status
get
Keys.3: Checklists
Keys.3.1: Get key checklists
get
Keys.3.2: Add key checklist
post
Keys.3.3: Reorder key checklists
patch
Keys.3.4: Rename key checklist
patch
Keys.3.5: Delete key checklist
del
Keys.3.6: Add key checklist item
post
Keys.3.7: Update key checklist item
patch
Keys.3.8: Delete key checklist item
del
Keys.3.9: Reorder key checklist items
patch
Keys.4: Notes
Keys.4.1: Get key notes
get
Keys.4.2: Add key note
post
Keys.4.3: Update key note
patch
Keys.4.4: Delete key note
del
Keys.5: Tasks
Keys.5.1: Get key tasks
get
Keys.5.2: Add key task
post
Keys.5.3: Update key task
patch
Keys.5.4: Delete key task
del
Keys.5.5: Reorder key tasks
patch
Key Pods.1
Key Pods.1.1: Get key pods
get
Key Pods.1.2: Add key pod
post
Key Pods.1.3: Add key pod (based on template)
post
Key Pods.1.4: Get pods available to be linked to this key
get
Key Pods.1.5: Link key pod to key
patch
Key Pods.1.6: Unlink key pod from key
patch
Key Pods.1.7: Get key pod
get
Key Pods.1.8: Update key pod
patch
Key Pods.1.9: Update key pod completion status
patch
Key Pods.1.10: Update key pod scale value
patch
Key Pods.1.11: Add pod type to key pod.
patch
Key Pods.1.12: Delete pod type from key pod
patch
Key Pods.1.13: Add scale to key pod
patch
Key Pods.1.14: Delete scale from key pod
patch
Key Pods.1.15: Archive key pod
patch
Key Pods.1.16: Get archived key pods
get
Key Pods.1.17: Unarchive key pod
patch
Key Pods.1.18: Bulk archive key pods
patch
Key Pods.1.19: Update key pod description
patch
Key Pods.1.20: Allow archival of key pod
patch
Key Pods.1.21: Copy key pod
post
Key Pods.1.22: Move key pod
patch
Key Pods.2: Attachments
Key Pods.2.1: Get key pod attachments
get
Key Pods.2.2: Add key pod attachment
patch
Key Pods.2.3: Rename key pod attachment
patch
Key Pods.2.4: Delete key pod attachment
del
Key Pods.3: Checklists
Key Pods.3.1: Get key pod checklists
get
Key Pods.3.2: Add key pod checklist
post
Key Pods.3.3: Reorder key pod checklists
patch
Key Pods.3.4: Delete key pod checklist
del
Key Pods.3.5: Rename key pod checklist
patch
Key Pods.3.6: Add key pod checklist item
post
Key Pods.3.7: Update key pod checklist item
patch
Key Pods.3.8: Delete key pod checklist item
del
Key Pods.3.9: Reorder key pod checklist items
patch
Key Pods.4: Comments
Key Pods.4.1: Get key pod comments
get
Key Pods.4.2: Add key pod comment
post
Key Pods.4.3: Update key pod comment
patch
Key Pods.4.4: Delete key pod comment
del
Key Pods.5: Notes
Key Pods.5.1: Get key pod notes
get
Key Pods.5.2: Add key pod note
post
Key Pods.5.3: Update key pod note
patch
Key Pods.5.4: Delete key pod note
del
Key Pods.6: Tasks
Key Pods.6.1: Get key pod tasks
get
Key Pods.6.2: Add key pod task
post
Key Pods.6.3: Update key pod task
patch
Key Pods.6.4: Delete key pod task
del
Key Pods.6.5: Assign key pod task
patch
Key Pods.6.6: Unassign key pod task
patch
Key Pods.6.7: Reorder key pod tasks
patch
Blocks.1
Blocks.1.1: Get blocks
get
Blocks.1.2: Add block
post
Blocks.1.3: Get blocks linked to pod
get
Blocks.1.4: Add block (based on template)
post
Blocks.1.5: Link block to key
patch
Blocks.1.6: Unlink block from key
patch
Blocks.1.7: Get blocks available to be linked to this key
get
Blocks.1.8: Get block
get
Blocks.1.9: Update block
patch
Blocks.1.10: Add block type to block
patch
Blocks.1.11: Delete block type from block
patch
Blocks.1.12: Add scale to block
patch
Blocks.1.13: Delete scale from block
patch
Blocks.1.14: Update block scale value
patch
Blocks.1.15: Update block description
patch
Blocks.1.16: Archive block
patch
Blocks.1.17: Unarchive block
patch
Blocks.1.18: Get archived blocks
get
Blocks.1.19: Bulk archive blocks
patch
Blocks.1.20: Allow archival of block
patch
Blocks.1.21: Copy block
post
Blocks.1.22: Move block
patch
Blocks.2: Attachments
Blocks.2.1: Get block attachments
get
Blocks.2.2: Add block attachment
patch
Blocks.2.3: Rename block attachment
patch
Blocks.2.4: Delete block attachment
del
Blocks.3: Charts
Blocks.3.1: Get linked block pods
get
Blocks.3.2: Get scale values for scale
get
Blocks.3.3: Get task status for block
get
Blocks.3.4: Get block grades for all students
get
Blocks.4: Checklists
Blocks.4.1: Get block checklists
get
Blocks.4.2: Add block checklist
post
Blocks.4.3: Reorder block checklists
patch
Blocks.4.4: Rename block checklist
patch
Blocks.4.5: Delete block checklist
del
Blocks.4.6: Add block checklist item
post
Blocks.4.7: Update block checklist item
patch
Blocks.4.8: Delete block checklist item
del
Blocks.4.9: Reorder block checklist items
patch
Blocks.5: Comments
Blocks.5.1: Get block comments
get
Blocks.5.2: Add block comment
post
Blocks.5.3: Update block comment
patch
Blocks.5.4: Delete block comment
del
Blocks.6: Notes
Blocks.6.1: Get block notes
get
Blocks.6.2: Add block note
post
Blocks.6.3: Update block note
patch
Blocks.6.4: Delete block note
del
Blocks.7: Tasks
Blocks.7.1: Get block tasks
get
Blocks.7.2: Add block task
post
Blocks.7.3: Update block task
patch
Blocks.7.4: Delete block task
del
Blocks.7.5: Assign block task
patch
Blocks.7.6: Unassign block task
patch
Blocks.7.7: Reorder block tasks
patch
Block Pods.1
Block Pods.1.1: Get block pods
get
Block Pods.1.2: Add block pod
post
Block Pods.1.3: Add block pod (based on template)
post
Block Pods.1.4: Link pod to block
patch
Block Pods.1.5: Unlink pod from block
patch
Block Pods.1.6: Get block pod
get
Block Pods.1.7: Update block pod
patch
Block Pods.1.8: Update block pod completion status
patch
Block Pods.1.9: Add pod type to block pod
patch
Block Pods.1.10: Delete pod type from block pod
patch
Block Pods.1.11: Add scale to block pod
patch
Block Pods.1.12: Delete scale from block pod
patch
Block Pods.1.13: Update block pod scale value
patch
Block Pods.1.14: Archive block pod
patch
Block Pods.1.15: Get archived block pods
get
Block Pods.1.16: Get pods available to be linked to this block
get
Block Pods.1.17: Unarchive block pod
patch
Block Pods.1.18: Bulk archive block pods
patch
Block Pods.1.19: Update block pod description
patch
Block Pods.1.20: Allow archival of block pod
patch
Block Pods.1.21: Copy block pod
post
Block Pods.1.22: Move block pod
patch
Block Pods.2: Attachments
Block Pods.2.1: Get block pod attachments
get
Block Pods.2.2: Add block pod attachment
patch
Block Pods.2.3: Rename block pod attachment
patch
Block Pods.2.4: Delete block pod attachment
del
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 students
get
Block Pods.4: Checklists
Block Pods.4.1: Get block pod checklists
get
Block Pods.4.2: Add block pod checklist
post
Block Pods.4.3: Reorder block pod checklists
patch
Block Pods.4.4: Delete block pod checklist
del
Block Pods.4.5: Rename block pod checklist
patch
Block Pods.4.6: Add block pod checklist item
post
Block Pods.4.7: Update block pod checklist item
patch
Block Pods.4.8: Delete block pod checklist item
del
Block Pods.4.9: Reorder block pod checklist items
patch
Block Pods.5: Comments
Block Pods.5.1: Get block pod comments
get
Block Pods.5.2: Add block pod comment
post
Block Pods.5.3: Update block pod comment
patch
Block Pods.5.4: Delete block pod comment
del
Block Pods.6: Notes
Block Pods.6.1: Get block pod notes
get
Block Pods.6.2: Add block pod note
post
Block Pods.6.3: Update block pod note
patch
Block Pods.6.4: Delete block pod note
del
Block Pods.7: Tasks
Block Pods.7.1: Get block pod tasks
get
Block Pods.7.2: Add block pod task
post
Block Pods.7.3: Update block pod task
patch
Block Pods.7.4: Delete block pod task
del
Block Pods.7.5: Assign block pod task
patch
Block Pods.7.6: Unassign block pod task
patch
Block Pods.7.7: Reorder block pod tasks
patch
Collaboration.1: Blocks
Collaboration.1.1: Get block collaborators
get
Collaboration.1.2: Update block ACL
patch
Collaboration.1.3: Unshare block from collaborator
patch
Collaboration.1.4: Share block with collaborator
patch
Collaboration.1.5: Share block with collaborator (along with pods)
patch
Collaboration.1.6: Get users this block can be shared with
get
Collaboration.1.7: Bulk share blocks with collaborators
patch
Collaboration.1.8: Leave block
patch
Collaboration.2: Block Pods
Collaboration.2.1: Get block pod collaborators
get
Collaboration.2.2: Share block pod with collaborator
patch
Collaboration.2.3: Unshare block pod from collaborator
patch
Collaboration.2.4: Bulk share block pods with collaborators
patch
Collaboration.2.5: Get users this block pod can be shared with
get
Collaboration.2.6: Update block pod ACL
patch
Collaboration.2.7: Leave block pod
patch
Collaboration.3: Key Pods
Collaboration.3.1: Get key pod collaborators
get
Collaboration.3.2: Share key pod with collaborator
patch
Collaboration.3.3: Bulk share key pods with collaborators
patch
Collaboration.3.4: Unshare key pod from collaborator
patch
Collaboration.3.5: Get users this key pod can be shared with
get
Collaboration.3.6: Update key pod ACL
patch
Collaboration.3.7: Leave key pod
patch
Project Keys.1
Project Keys.1.1: Add a project pod
post
Project Keys.1.2: Add project pod (based on template)
post
Project Keys.1.3: Link project pod to block
patch
Project Keys.1.4: Reorder project pods
patch
Project Keys.1.5: Copy project pod
post
Project Keys.1.6: Move project pod
patch
Project Keys.1.7: Assign project pod
patch
Project Keys.1.8: Unassign project pod
patch
Project Keys.2: Lists
Project Keys.2.1: Add project block list
post
Project Keys.2.2: Get project lists
get
Project Keys.2.3: Copy all pods in project list
post
Project Keys.2.4: Bulk copy pods in project list
post
Project Keys.2.5: Move all pods in project list
patch
Project Keys.2.6: Bulk move pods in project list
patch
Project Keys.2.7: Move project list
patch
Project Keys.2.8: Get project list
get
Project Keys.2.9: Rename project list
patch
Project Keys.2.10: Reorder project list
patch
Project Keys.2.11: Archive project list
patch
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 block
get
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 block
patch
Teacher Keys.2.7: Bulk publish pod grades for a student
patch
Teacher Keys.2.8: Bulk publish pod grades for students
patch
Teacher Keys.2.9: Get block grades for all students
get
Teacher Keys.2.10: Get pod grades for all students
get
Teacher Keys.2.11: Assign grade to student
patch
Teacher Keys.2.12: Assign pod grade for a student (as teacher)
patch
Teacher Keys.2.13: Get student profile
get
Attributes.1
Attributes.1.1: Get displayable attributes of Key, Block and Pod
get
Attributes.1.2: Update key display attributes
patch
Attributes.1.3: Update block display attributes
patch
Attributes.1.4: Update key pod display attributes
patch
Attributes.1.5: Update block pod display attributes
patch
Block Types.1
Block Types.1.1: Get block types
get
Block Types.1.2: Add block type
post
Block Types.1.3: Update block type
patch
Block Types.1.4: Delete block type
del
Block Types.1.5: Get blocks using block type
get
Comments.1
Comments.1.1: Get recent comments
get
Conversations.1
Conversations.1.1: Get unread conversations count
get
Conversations.1.2: Get user conversations
get
Conversations.1.3: Add private or group conversation
post
Conversations.1.4: Get conversation for given usernames
get
Conversations.1.5: Send message to an existing conversation
patch
Conversations.1.6: Get conversation
get
Conversations.1.7: Delete conversation
del
Conversations.1.8: Leave conversation
patch
Conversations.1.9: Archive conversation
patch
Favorites.1
Favorites.1.1: Get favorites
get
Favorites.1.2: Add key as favorite
post
Favorites.1.3: Add block as favorite
post
Favorites.1.4: Add pod as favorite
post
Favorites.1.5: Add block pod as favorite
post
Favorites.1.6: Delete favorite
del
Followers.1
Followers.1.1: Add user to `Follow Us` list
patch
Followers.1.2: Get Followers
get
Notifications.1
Notifications.1.1: Get notifications
get
Notifications.1.2: Get unread notifications
get
Notifications.1.3: Get unread notification count
get
Notifications.1.4: Mark notification as read
patch
Notifications.1.5: Mark notifications as read (in bulk)
patch
Pod Types.1
Pod Types.1.1: Get pod types
get
Pod Types.1.2: Add pod type
post
Pod Types.1.3: Update pod type
patch
Pod Types.1.4: Delete pod type
del
Pod Types.1.5: Get pods using pod type
get
Profile.1
Profile.1.1: Get user profile
get
Profile.1.2: Update user's profile
patch
Profile.1.3: Update username
patch
Profile.1.4: Blocks user from sending messages
patch
Profile.1.5: Unblocks user
patch
Registration.1
Registration.1.1: Register new user by email
post
Registration.1.2: Sign in by email
post
Registration.1.3: Reset password
patch
Registration.1.4: Activate user
patch
Relations.1
Relations.1.1: Get relations matching search token
get
Relations.1.2: Get relations for key
get
Relations.1.3: Get relations for block
get
Relations.1.4: Get relations for pod
get
Relations.1.5: Get relations for block pod
get
Relations.1.6: Relate key to key
patch
Relations.1.7: Unrelate key from key
patch
Relations.1.8: Relate block to key
patch
Relations.1.9: Unrelate block from key
patch
Relations.1.10: Relate pod to key
patch
Relations.1.11: Unrelate pod from key
patch
Relations.1.12: Relate pod to block
patch
Relations.1.13: Unrelate pod from block
patch
Relations.1.14: Relate block to block
patch
Relations.1.15: Unrelate block from block
patch
Relations.1.16: Relate pod to pod
patch
Relations.1.17: Unrelate pod from pod
patch
Scales.1
Scales.1.1: Get scales
get
Scales.1.2: Add scale
post
Scales.1.3: Get scale
get
Scales.1.4: Update scale
patch
Scales.1.5: Delete scale
del
Scales.1.6: Get blocks using scale
get
Scales.1.7: Get pods using scale
get
Scheduler.1
Scheduler.1.1: Get events in given window
get
Scheduler.1.2: Get events for given day
get
Scheduler.1.3: Get standalone events
get
Scheduler.1.4: Add standalone event
post
Scheduler.1.5: Update standalone event
patch
Scheduler.1.6: Delete standalone event
del
Search.1
Search.1.1: Search key, block or pod by token
get
Search.1.2: Search user by token
get
Templates.1
Templates.1.1: Get key templates
get
Templates.1.2: Get block templates
get
Templates.1.3: Get pod templates
get
User.1
User.1.1: Get users
get
User.1.2: Get user by UUID
get
User.1.3: Get user by Email
get
User.1.4: Deactivate user account
patch
User.1.5: Delete user account
patch
Version.1
Version.1.1: Get latest version
get
Version.1.2: Get app status
get
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
Personal and Group Conversations
Ask AI
All your conversation needs under one umbrella.
