This PowerShell module wraps around and eases the use of the ClickUp API in PowerShell scripts and projects.
This PowerShell module is an independent, third-party project and is not affiliated with, supported by, endorsed by, or in any way associated with ClickUp or its parent organizations. All trademarks, service marks, and product names referenced remain the property of their respective owners. Use of the ClickUp name or API within this project is for descriptive purposes only. This module is provided “as is,” without warranty of any kind, express or implied, including but not limited to the implied warranties of merchantability, fitness for a particular purpose, and non-infringement. Users assume all risks associated with the installation, configuration, and use of this module and are responsible for ensuring compliance with ClickUp’s API terms, policies, and applicable laws.
Install-Module -Name ClickupAPIhttps://www.powershellgallery.com/packages/ClickupAPI/
# Imports the ClickUp module.
Import-Module ClickupAPI
# Adds a ClickUp API key to the current session.
Add-ClickUpAPIKey -Key "your_api_key"
# Exports the ClickUp module settings to a configuration file.
Export-ClickUpModuleSettings# Imports the ClickUp module.
Import-Module ClickupAPI
# Imports the ClickUp module settings from a configuration file.
Import-ClickUpModuleSettings| API Reference | Code | Docs | Error Handling | Tested | Comments |
|---|---|---|---|---|---|
| Attachments | ✅ | ✅ | ✅ | ||
| Authorization | ✅ | ✅ | ✅ | ||
| Checklists | ✅ | ✅ | ✅ | ||
| Comments | ✅ | ✅ | ✅ | ||
| Custom Fields | ✅ | ✅ | ✅ | ||
| Custom Task Types | ✅ | ✅ | ✅ | ||
| Dependencies | ✅ | ✅ | ✅ | ||
| Folders | ✅ | ✅ | ✅ | ||
| Goals | ✅ | ✅ | ✅ | ||
| Guests | ✅ | ✅ | ✅ | Enterprise only | |
| Lists | ✅ | ✅ | ✅ | ||
| Members | ✅ | ✅ | ✅ | ||
| Roles | ✅ | ✅ | ✅ | ||
| Shared Hierarchy | ✅ | ✅ | ✅ | ||
| Spaces | ✅ | ✅ | ✅ | ||
| Tags | ✅ | ✅ | ✅ | ||
| Tasks | ✅ | ✅ | ✅ | ||
| Task Templates | ✅ | ✅ | ✅ | ||
| Teams | ✅ | ✅ | ✅ | ||
| Time Tracking | ✅ | ✅ | ✅ | Partial implementation only. v2.0 will be implemented only. Legacy will not be implemented. | |
| User Groups | ✅ | ✅ | ✅ | ||
| Users | ✅ | ✅ | ✅ | Enterprise only | |
| Views | ✅ | ✅ | ✅ | ||
| Webhooks | ✅ | ✅ | ✅ |
| API Reference | Code | Docs | Tested | Comments |
|---|---|---|---|---|
| Authentication | ||||
| Rate Limit | ||||
| Error Handling |