clickup_api
Version:
No oficial module for ClickUp API
135 lines (93 loc) • 5.15 kB
Markdown
# [clickup_api](https://clickup.com/)
[](https://www.npmjs.com/package/clickup_api)
This module is not official [ClickUp API](https://clickup.com/api).
The ```clickup_api``` is a wrap. Used to simplify the calls to the Clickup API.
## Table of contents
- [Issues](#issues)
- [Install](#install)
- [Quick Start](#quick-start)
- [Docs](#docs)
- [Examples](#examples)
- [Changes log](#changes-log)
- [Contributing](#contributing)
- [License](#license)
## Issues
Only support ```API Token```. The ```App token``` is not supported yet.
To report a issue: [Report](https://github.com/lpg2709/clickup_api/issues).
> Before reporting the problem, test the call on the [API](https://clickup.com/api) page, if it is on the Clickup API itself, report [here](https://feedback.clickup.com/).
## Install
This is a [Node.js](https://nodejs.org/en/) module available through the
[npm registry](https://www.npmjs.com/).
Before installing, [download and install Node.js](https://nodejs.org/en/download/).
Installation is done using the
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
```bash
npm install clickup_api
```
## Quick Start
First thing to do is import the module to the scritp.
```javascript
const clickup_api = require("clickup_api");
```
Initialize a new object. This object go use the ```API Token``` to do all calls.
```javascript
const Clickup = new clickup_api("access_token");
```
After that you can call all method of the Clickup class.
To create a task:
```javascript
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](https://github.com/mcannesson))
By default, the request is made on api.clickup.com:443. If you want to set other host:
```javascript
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](https://clickup.com/api).
## Examples
To view the examples, you can access the [github](https://github.com/lpg2709/clickup_api) page, in folder ```examples``` you will find examples for all member.
- [Attachments](https://github.com/lpg2709/clickup_api/tree/master/examples/Attachments)
- [Checklists](https://github.com/lpg2709/clickup_api/tree/master/examples/Checklists)
- [Comments](https://github.com/lpg2709/clickup_api/tree/master/examples/Comments)
- [CustomFields](https://github.com/lpg2709/clickup_api/tree/master/examples/CustomFields)
- [Dependencies](https://github.com/lpg2709/clickup_api/tree/master/examples/Dependencies)
- [Folders](https://github.com/lpg2709/clickup_api/tree/master/examples/Folders)
- [Goals](https://github.com/lpg2709/clickup_api/tree/master/examples/Goals)
- [Lists](https://github.com/lpg2709/clickup_api/tree/master/examples/Lists)
- [Members](https://github.com/lpg2709/clickup_api/tree/master/examples/Members)
- [Roles](https://github.com/lpg2709/clickup_api/tree/master/examples/Roles)
- [SharedHierarchy](https://github.com/lpg2709/clickup_api/tree/master/examples/SharedHierarchy)
- [Spaces](https://github.com/lpg2709/clickup_api/tree/master/examples/Spaces)
- [Tags](https://github.com/lpg2709/clickup_api/tree/master/examples/Tags)
- [TaskCheckList](https://github.com/lpg2709/clickup_api/tree/master/examples/TaskCheckList)
- [TaskRelationships](https://github.com/lpg2709/clickup_api/tree/master/examples/TaskRelationships)
- [Tasks](https://github.com/lpg2709/clickup_api/tree/master/examples/Tasks)
- [TaskTemplates](https://github.com/lpg2709/clickup_api/tree/master/examples/TaskTemplates)
- [Teams](https://github.com/lpg2709/clickup_api/tree/master/examples/Teams)
- [TimeTracking](https://github.com/lpg2709/clickup_api/tree/master/examples/TimeTracking)
- [Users](https://github.com/lpg2709/clickup_api/tree/master/examples/Users)
- [Views](https://github.com/lpg2709/clickup_api/tree/master/examples/Views)
- [Webhooks](https://github.com/lpg2709/clickup_api/tree/master/examples/Webhooks)
## Changes log
All changes by version can be see on [CHANGELOG.md](https://raw.githubusercontent.com/lpg2709/clickup_api/master/CHANGELOG.md) on [github](https://github.com/lpg2709/clickup_api)
## Contributing
See [CONTRIBUTING.md](https://github.com/lpg2709/clickup_api/blob/master/CONTRIBUTING.md) to instruction for help the package.
## License
[MIT](LICENSE)