This module is not officialClickUp API.
Theclickup_apiis a wrap. Used to simplify the calls to the Clickup API.
Only supportAPI Token.TheApp tokenis not supported yet.
To report a issue:Report.
Before reporting the problem, test the call on theAPIpage, if it is on the Clickup API itself, reporthere.
This is aNode.jsmodule available through the npm registry.
Before installing,download and install Node.js.
Installation is done using the
npm installcommand:
npm install clickup_apiFirst thing to do is import the module to the scritp.
constclickup_api=require("clickup_api");Initialize a new object. This object go use theAPI Tokento do all calls.
constClickup=newclickup_api("access_token");After that you can call all method of the Clickup class.
To create a task:
vardata={
"name":"New Task Name",
"content":"New Task Content",
"status":"Open"
};
varinfo=awaitClickup.Tasks.create_task("list_id",data);
console.log(info);Starting from version1.4.0,the module allow you to use a custom host and port for make requests. (Implemented by@mcannesson)
By default, the request is made on api.clickup:443. If you want to set other host:
constclickup_api=require("clickup_api");
constClickup=newclickup_api("access_token",{"host":"my-custom-host","port":42069,"pathPrefix":""});Where:
- host:Ip or DNS from host.
- port:Port of the service.
- pathPrefix:This is concatenate in from of every path.
The module use all specification of theClickUp API,pleas visitClickUp API.
To view the examples, you can access thegithubpage, in folderexamplesyou will find examples for all member.
- Attachments
- Checklists
- Comments
- CustomFields
- Dependencies
- Folders
- Goals
- Lists
- Members
- Roles
- SharedHierarchy
- Spaces
- Tags
- TaskCheckList
- TaskRelationships
- Tasks
- TaskTemplates
- Teams
- TimeTracking
- Users
- Views
- Webhooks
All changes by version can be see onCHANGELOG.mdongithub
SeeCONTRIBUTING.mdto instruction for help the package.