Snowpal Project Management
A complete Project Management API for all your needs. Check out https://developers.snowpal.com (Developer Guide and API Reference), and https://snowpal.com (Example Web App using this API), and https://consulting.snowpal.com/iOSApp (Example iPhone App using this API).
Snowpal Project Management endpoints
| Method | Endpoint | Description |
|---|---|---|
| Blocks.1 | ||
| PATCH |
/blocks/{id}/archive /blocks/{id}/archive |
When a block is archived, it will still be available under other keys (if it was linked to more than 1 key). If this is the last (aka, _only_) key that the block was associated… |
| PATCH |
/blocks/{id}/scales/{scale-id} /blocks/{id}/scales/{scale-id} |
Add a scale to a block. There are some system scales provided to you out of the box but you are able to add custom scales as well. "A scale can either be:" - an _alphabetic_… |
| PATCH |
/blocks/{id} /blocks/{id} |
Update block attributes. You can update one or more attributes at the same time. |
| PATCH |
/blocks/{id}/unarchive /blocks/{id}/unarchive |
Once you unarchive a block, it will appear under the Key and be available for use again. |
| PATCH |
/blocks/{id}/block-types /blocks/{id}/block-types |
Remove a block type from a block. |
| PATCH |
/blocks/{id}/description /blocks/{id}/description |
Update description. If you use an RTE (_say_, Quill for instance), you can store it in the format understood by the RTE. |
| PATCH |
/keys/{id}/blocks/{block-id}/unlink /keys/{id}/blocks/{block-id}/unlink |
Unlink a block from a key. If the block is linked to other keys, it will still be available under those keys. If this is the last key that the block is linked to (_aka_, the only… |
| PATCH |
/blocks/{id}/scale-value /blocks/{id}/scale-value |
Add a scale value to a block. Note that the scale value assigned has to conform with the scale associated with the block. Use the _Fetch Block_ endpoint response to identify the… |
| POST |
/blocks/{id}/copy /blocks/{id}/copy |
Duplicate a block. You can choose to copy all the associated pods, and/or tasks. |
| POST |
/keys/{id}/blocks/by-template /keys/{id}/blocks/by-template |
When you add a block, you can choose to create it based on one of the existing templates. And if you choose to do it, you will need to specify a `template_id`. If you do not want… |
| Blocks.2: Attachments | ||
| DELETE |
/block-attachments/{id} /block-attachments/{id} |
Deletes block attachment |
| PATCH |
/blocks/{id}/attachments /blocks/{id}/attachments |
Adds attachment to given block. |
| Blocks.3: Charts | ||
| GET |
/charts/keys/{id}/blocks/{block-id}/linked-resources /charts/keys/{id}/blocks/{block-id}/linked-resources |
Get block pods linked to given block or key. |
| Blocks.6: Notes | ||
| DELETE |
/block-notes/{id} /block-notes/{id} |
Deletes a block note for given ID. |
| POST |
/blocks/{id}/notes /blocks/{id}/notes |
Adds a block note. |
| Blocks.7: Tasks | ||
| PATCH |
/block-tasks/{id}/assign /block-tasks/{id}/assign |
Assigns block task to one or more users listed in `userIds`. |
| DELETE |
/block-tasks/{id} /block-tasks/{id} |
Deletes block task for given `taskId`. |
| PATCH |
/blocks/{id}/tasks/reorder /blocks/{id}/tasks/reorder |
Reorders block tasks. |
| GET |
/blocks/{id}/tasks /blocks/{id}/tasks |
Returns block tasks. |
| Block Pods.1 | ||
| GET |
/block-pods/{id} /block-pods/{id} |
Returns block pod. Alternate endpoint - `blocks/:id/pods/:id`. |
| PATCH |
/block-pods/{id}/unarchive /block-pods/{id}/unarchive |
Unarchives block pod. Once unarchived, the pod will be available for further use. Alternate path - `/blocks/:id/pods/:id/unarchive`. |
| PATCH |
/blocks/{id}/pods/{pod-id}/unlink /blocks/{id}/pods/{pod-id}/unlink |
Unlink a pod from a block. If the pod is linked to other blocks, that hierarchy will still be maintained. If the pod is not linked to any other block, you can still find the pod… |
| Block Pods.5: Comments | ||
| PATCH |
/block-pod-comments/{id} /block-pod-comments/{id} |
Updates block pod comment. A user can only update a comment they added. |
| POST |
/block-pods/{id}/comments /block-pods/{id}/comments |
Adds block pod comment. A block pod can have any number of comments, and they are available to all collaborators. |
| GET |
/block-pods/{id}/comments /block-pods/{id}/comments |
Returns block pod comments. |
| Block Pods.6: Notes | ||
| POST |
/block-pods/{id}/notes /block-pods/{id}/notes |
Adds a block pod note. |
| Collaboration.2: Block Pods | ||
| PATCH |
/block-pods/{id}/leave /block-pods/{id}/leave |
User will lose access immediately to a block pod that they leave. |
| PATCH |
/block-pods/{id}/users/{user-id}/unshare /block-pods/{id}/users/{user-id}/unshare |
Unshare block pod from user. The user will cease to have access to this block pod. |
| PATCH |
/block-pods/users/{id}/share /block-pods/users/{id}/share |
You can bulk share block pods with a list of collaborators by granting all of them the same level of access. |
| GET |
/search/block-pods/{id}/shareable/users /search/block-pods/{id}/shareable/users |
A block pod can be shared with a user only once. So, when you search for a user, this will return all users that match your search query that do not already have access to the… |
| PATCH |
/block-pods/{id}/users/{user-id}/share /block-pods/{id}/users/{user-id}/share |
Collaborate with users by sharing a block pod with them. You can grant one of 3 levels of access: - Read: Grant read access if you want the collaborator to be able to just view… |
| PATCH |
/block-pods/{id}/users/{user-id}/acl /block-pods/{id}/users/{user-id}/acl |
Updates block pod ACL to given access level (as defined in `podAcl`). |
| GET |
/block-pods/{id}/acl /block-pods/{id}/acl |
Returns block pod collaborators. Alternate endpoint - `/blocks/:id/pods/:id/acl`. |
| Collaboration.3: Key Pods | ||
| GET |
/pods/{id}/acl /pods/{id}/acl |
Returns key pod collaborators. Alternate endpoint - `/pods/:id/collaborators`. |
| Conversations.1 | ||
| PATCH |
/conversations/{id}/archive /conversations/{id}/archive |
Archives a group conversation. When a group conversation is archived, it will be hidden from user's conversations list till the point when a new message is sent to that… |
| GET |
/conversations/{id} /conversations/{id} |
Returns existing conversation for given ID. |
| GET |
/conversations/unread-status /conversations/unread-status |
Returns count of unread conversations (aka, conversations that have at least one message that user has not yet read). |
| GET |
/conversations /conversations |
Returns user conversations. |
| GET |
/conversations/by-usernames /conversations/by-usernames |
Returns conversation for given usernames (if there happens to be one). |
| DELETE |
/conversations/{id} /conversations/{id} |
Deletes a conversation. |
| Dashboard.2: Charts | ||
| GET |
/charts/dashboard/scales /charts/dashboard/scales |
Returns all scales along with both blocks and pods that use those scales. |
| GET |
/charts/dashboard/keys-blocks-pods /charts/dashboard/keys-blocks-pods |
Returns user keys, blocks and pods. |
| GET |
/charts/dashboard/block-types /charts/dashboard/block-types |
Returns all block types along with blocks that use those block types. |
| GET |
/charts/dashboard/pod-types /charts/dashboard/pod-types |
Returns all pod types along with pods that use those pod types. |
| GET |
/charts/dashboard/keys/filters /charts/dashboard/keys/filters |
Returns `created by me`, `shared with me`, and `shared with others` filter results for all keys except system keys. |
| GET |
/charts/dashboard/system-keys/filters /charts/dashboard/system-keys/filters |
Returns `created by me`, `shared with me`, and `shared with others` filter results for all system keys. |
| GET |
/charts/dashboard/task-status /charts/dashboard/task-status |
Returns a breakdown of tasks (by status) across all keys. |
| GET |
/charts/dashboard/system-keys /charts/dashboard/system-keys |
Returns system keys, blocks and pods. |
| Followers.1 | ||
| PATCH |
/app/followers /app/followers |
Returns followers. |
| Keys.2: Charts | ||
| GET |
/charts/keys/{id}/filters /charts/keys/{id}/filters |
Returns `created by me`, `shared with me`, and `shared with others` filter results for given key. |
Snowpal Project Management pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|