{"id":18290577,"url":"https://github.com/lpg2709/clickup_api","last_synced_at":"2025-04-05T10:30:44.760Z","repository":{"id":46193405,"uuid":"248068394","full_name":"lpg2709/clickup_api","owner":"lpg2709","description":"No oficial module for ClickUp API","archived":false,"fork":false,"pushed_at":"2024-06-08T18:05:24.000Z","size":225,"stargazers_count":6,"open_issues_count":0,"forks_count":11,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T04:55:38.395Z","etag":null,"topics":["clickup","clickup-api","javascript","node-js","node-module","npm"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/clickup_api","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lpg2709.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-17T20:37:52.000Z","updated_at":"2024-06-08T18:04:03.000Z","dependencies_parsed_at":"2023-11-21T12:30:55.257Z","dependency_job_id":"74e4d570-3a05-494f-95a4-6a7804837575","html_url":"https://github.com/lpg2709/clickup_api","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpg2709%2Fclickup_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpg2709%2Fclickup_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpg2709%2Fclickup_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpg2709%2Fclickup_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lpg2709","download_url":"https://codeload.github.com/lpg2709/clickup_api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247324375,"owners_count":20920629,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clickup","clickup-api","javascript","node-js","node-module","npm"],"created_at":"2024-11-05T14:11:30.248Z","updated_at":"2025-04-05T10:30:44.157Z","avatar_url":"https://github.com/lpg2709.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [clickup_api](https://clickup.com/)\n\n[![npm](https://img.shields.io/npm/v/clickup_api?style=flat-square)](https://www.npmjs.com/package/clickup_api)\n![npm](https://img.shields.io/npm/dw/clickup_api?style=flat-square\u0026)\n![NPM](https://img.shields.io/npm/l/clickup_api?style=flat-square)\n![GitHub last commit](https://img.shields.io/github/last-commit/lpg2709/clickup_api?style=flat-square)\n\nThis module is not official [ClickUp API](https://clickup.com/api).\n\nThe ```clickup_api``` is a wrap. Used to simplify the calls to the Clickup API.\n\n## Table of contents\n\n- [Issues](#issues)\n- [Install](#install)\n- [Quick Start](#quick-start)\n- [Docs](#docs)\n- [Examples](#examples)\n- [Changes log](#changes-log)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Issues\n\nOnly support ```API Token```. The ```App token``` is not supported yet.\n\nTo report a issue: [Report](https://github.com/lpg2709/clickup_api/issues).\n\n\u003e 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/).\n\n## Install\n\nThis is a [Node.js](https://nodejs.org/en/) module available through the\n[npm registry](https://www.npmjs.com/).\n\nBefore installing, [download and install Node.js](https://nodejs.org/en/download/).\n\nInstallation is done using the\n[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):\n\n```bash\nnpm install clickup_api\n```\n\n## Quick Start\n\nFirst thing to do is import the module to the scritp.\n\n```javascript\nconst clickup_api = require(\"clickup_api\");\n```\n\nInitialize a new object. This object go use the ```API Token``` to do all calls.\n\n```javascript\nconst Clickup = new clickup_api(\"access_token\");\n```\n\nAfter that you can call all method of the Clickup class.\n\nTo create a task:\n\n```javascript\nvar data = {\n    \"name\": \"New Task Name\",\n    \"content\": \"New Task Content\",\n    \"status\": \"Open\"\n};\nvar info = await Clickup.Tasks.create_task(\"list_id\", data);\n\nconsole.log(info);\n```\n\n## Custom Host\n\nStarting 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))\n\nBy default, the request is made on api.clickup.com:443. If you want to set other host:\n\n```javascript\nconst clickup_api = require(\"clickup_api\");\nconst Clickup = new clickup_api(\"access_token\", { \"host\": \"my-custom-host.com\", \"port\": 42069, \"pathPrefix\": \"\" });\n```\n\nWhere:\n\n- **host**: Ip or DNS from host.\n- **port**: Port of the service.\n- **pathPrefix**: This is concatenate in from of every path.\n\n## Docs\n\n### ClickUp API\n\nThe module use all specification of the ```ClickUp API```, pleas visit [ClickUp API](https://clickup.com/api).\n\n## Examples\n\nTo 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.\n\n- [Attachments](https://github.com/lpg2709/clickup_api/tree/master/examples/Attachments)\n- [Checklists](https://github.com/lpg2709/clickup_api/tree/master/examples/Checklists)\n- [Comments](https://github.com/lpg2709/clickup_api/tree/master/examples/Comments)\n- [CustomFields](https://github.com/lpg2709/clickup_api/tree/master/examples/CustomFields)\n- [Dependencies](https://github.com/lpg2709/clickup_api/tree/master/examples/Dependencies)\n- [Folders](https://github.com/lpg2709/clickup_api/tree/master/examples/Folders)\n- [Goals](https://github.com/lpg2709/clickup_api/tree/master/examples/Goals)\n- [Lists](https://github.com/lpg2709/clickup_api/tree/master/examples/Lists)\n- [Members](https://github.com/lpg2709/clickup_api/tree/master/examples/Members)\n- [Roles](https://github.com/lpg2709/clickup_api/tree/master/examples/Roles)\n- [SharedHierarchy](https://github.com/lpg2709/clickup_api/tree/master/examples/SharedHierarchy)\n- [Spaces](https://github.com/lpg2709/clickup_api/tree/master/examples/Spaces)\n- [Tags](https://github.com/lpg2709/clickup_api/tree/master/examples/Tags)\n- [TaskCheckList](https://github.com/lpg2709/clickup_api/tree/master/examples/TaskCheckList)\n- [TaskRelationships](https://github.com/lpg2709/clickup_api/tree/master/examples/TaskRelationships)\n- [Tasks](https://github.com/lpg2709/clickup_api/tree/master/examples/Tasks)\n- [TaskTemplates](https://github.com/lpg2709/clickup_api/tree/master/examples/TaskTemplates)\n- [Teams](https://github.com/lpg2709/clickup_api/tree/master/examples/Teams)\n- [TimeTracking](https://github.com/lpg2709/clickup_api/tree/master/examples/TimeTracking)\n- [Users](https://github.com/lpg2709/clickup_api/tree/master/examples/Users)\n- [Views](https://github.com/lpg2709/clickup_api/tree/master/examples/Views)\n- [Webhooks](https://github.com/lpg2709/clickup_api/tree/master/examples/Webhooks)\n\n## Changes log\n\nAll 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)\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/lpg2709/clickup_api/blob/master/CONTRIBUTING.md) to instruction for help the package.\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flpg2709%2Fclickup_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flpg2709%2Fclickup_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flpg2709%2Fclickup_api/lists"}