Skip to content

Latest commit

 

History

History
134 lines (93 loc) · 5.03 KB

README.md

File metadata and controls

134 lines (93 loc) · 5.03 KB
Raw

clickup_api

npm npm NPM GitHub last commit

This module is not official ClickUp API.

The clickup_api is a wrap. Used to simplify the calls to the Clickup API.

Table of contents

Issues

Only support API Token. The App token is not supported yet.

To report a issue: Report.

Before reporting the problem, test the call on the API page, if it is on the Clickup API itself, report here.

Install

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

Installation is done using the npm install command:

npm install clickup_api

Quick Start

First thing to do is import the module to the scritp.

const clickup_api = require("clickup_api");

Initialize a new object. This object go use the API Token to do all calls.

const Clickup = new clickup_api("access_token");

After that you can call all method of the Clickup class.

To create a task:

var data = {
    "name": "New Task Name",
    "content": "New Task Content",
    "status": "Open"
};
var info = await Clickup.Tasks.create_task("list_id", data);

console.log(info);

Custom Host

Starting from version 1.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.com:443. If you want to set other host:

const clickup_api = require("clickup_api");
const Clickup = new clickup_api("access_token", { "host": "my-custom-host.com", "port": 42069, "pathPrefix": "" });

Where:

  • host: Ip or DNS from host.
  • port: Port of the service.
  • pathPrefix: This is concatenate in from of every path.

Docs

ClickUp API

The module use all specification of the ClickUp API, pleas visit ClickUp API.

Examples

To view the examples, you can access the github page, in folder examples you will find examples for all member.

Changes log

All changes by version can be see on CHANGELOG.md on github

Contributing

See CONTRIBUTING.md to instruction for help the package.

License

MIT