Skip to content

Shawn-E/nodejs-clickup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

Nodejs ClickUp

Node ClickUp is a Node.js Wrapper for ClickUp API


Functions / Exports


Initialise Package:

    const ClickUp = require('node-clickup');
    const client = new ClickUp('<YOUR_TOKEN_HERE>');

To get your token look here.


createTask

Creates a task in a list.

    let data = await client.createTask('<LIST_ID_HERE>', {
      name: 'Task Name Here',
      description: 'Task Description Here'
    });

    console.log(data)

For more info on what you can pass into the second param, head to this site => ClickUp API Refrence - Create Task

deleteTask

Delete a task in a list.

    let data = await client.deleteTask('<TASK_ID_HERE>');

    console.log(data)

commentOnTask

Comment on a task.

    let data = await client.commentOnTask('<TASK_ID_HERE>', {
        comment_text: 'Task comment coasdntent'
    });

    console.log(data)

For more info on what you can pass into the second param, head to this site => ClickUp API Refrence - Create Task Comment

updateTask

Update a task.

    let data = await client.updateTask('<TASK_ID_HERE>', {
        name: 'Updated Task Name',
        description: 'Updated Task Description'
    });

    console.log(data)

For more info on what you can pass into the second param, head to this site => ClickUp API Refrence - Update Task

getTask

Get a task by task id.

    let data = await client.getTask('<TASK_ID_HERE>', <include_subtasks?>);

    console.log(data)

For more info on what you can pass into the second param, head to this site => ClickUp API Refrence - Get Task

getTasks

get tasks from list id.

    let data = await client.updateTask('<LIST_ID_HERE>', {
        <INSERT_FILTERS_HERE>
    });

    console.log(data)

For more info on what you can pass into the second param, head to this site => ClickUp API Refrence - Get Tasks


Knowledge Base

Getting ClickUp Token

  • Open the ClickUp dashboard.
  • Click on your profile icon in the bottom left.
  • Click on Apps under your user profile.
  • Copy your API token it should start with pk API TOKEN PICTURE

More coming soon!

About

A API wrapper for ClickUp's V2 Api

Resources

Stars

Watchers

Forks

Packages

No packages published