{"id":20879250,"url":"https://github.com/edsol/php-clickup-api-client","last_synced_at":"2025-05-12T16:31:22.714Z","repository":{"id":177297511,"uuid":"660182924","full_name":"Edsol/php-clickup-api-client","owner":"Edsol","description":"Unofficial PHP ClickUp API client (v2)","archived":false,"fork":false,"pushed_at":"2024-09-02T07:28:06.000Z","size":40,"stargazers_count":3,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-09T23:15:41.403Z","etag":null,"topics":["api","api-client","api-client-php","clickup","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Edsol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2023-06-29T12:33:18.000Z","updated_at":"2024-11-20T23:44:53.000Z","dependencies_parsed_at":"2024-11-18T07:15:46.429Z","dependency_job_id":"342813ba-1676-4be3-b79a-caa7e15f352e","html_url":"https://github.com/Edsol/php-clickup-api-client","commit_stats":null,"previous_names":["edsol/php-clickup-api-client"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Edsol%2Fphp-clickup-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Edsol%2Fphp-clickup-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Edsol%2Fphp-clickup-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Edsol%2Fphp-clickup-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Edsol","download_url":"https://codeload.github.com/Edsol/php-clickup-api-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253336926,"owners_count":21892799,"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":["api","api-client","api-client-php","clickup","php"],"created_at":"2024-11-18T07:15:42.422Z","updated_at":"2025-05-12T16:31:22.419Z","avatar_url":"https://github.com/Edsol.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align='center'\u003e\nUnofficial \u003ca href=\"http://clickup.com\"\u003eClickUp\u003c/a\u003e API Client \u003c/br\u003esee \u003ca href=\"https://clickup.com/api\"\u003eClickUp Api Docs\u003c/a\u003e\n\n[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)\n![](https://vsmarketplacebadge.apphb.com/version-short/edsol.clickup.svg\n)\n![](https://vsmarketplacebadge.apphb.com/downloads-short/edsol.clickup.svg\n)\n![](https://vsmarketplacebadge.apphb.com/rating-short/edsol.clickup.svg\n)\n\u003c/h1\u003e\n\n\n\n## Requirements\n\nYou need to have a ClickUp token, use [official guide](https://docs.clickup.com/en/articles/1367130-getting-started-with-the-clickup-api) to create one\n\n\n## Install\n```bash\ncomposer require \"edsol/clickup-php\"\n```\n\n## Implementations\n\n### Team\n- [x] Read\n- [x] get Spaces\n\n### Space\n- [x] Read\n- [x] get Tags\n\n### Folder\n- [x] Create\n- [x] Read\n- [x] Create List\n\n### Task\n- [x] Create\n- [x] Read\n- [x] Update\n- [x] Delete\n- [x] Add attachment/s\n- [x] Add assignee/s\n- [x] Get members\n    ### Comment\n    - [x] Read\n    - [x] Create\n    - [x] Update\n    - [x] Delete\n\n### Webhook\n- [x] List\n- [x] Create\n- [x] Update\n- [x] Delete\n\n\n## Usages\n\n### Initialize client\n```php\n$clickup = new \\ClickUpClient\\Client('CLICK_UP_API_TOKEN');\n```\n\n### Team\n\n```php\n$clickup-\u003eteam()-\u003eall();\n$clickup-\u003eteam()-\u003espaces();\n$clickup-\u003eteam()-\u003euser('USER_ID');\n```\n### Space\n\n```php\n$clickup-\u003espace()-\u003eget(\"SPACE_ID\");\n$clickup-\u003espace('SPACE_ID')-\u003etags();\n$clickup-\u003espace('SPACE_ID')-\u003efolders();\n$clickup-\u003espace('SPACE_ID')-\u003efolderlessLists();\n```\n### Folder\n\n```php\n$clickup-\u003efolder(\"SPACE_ID\")-\u003elists();\n$clickup-\u003efolder(\"FOLDER_ID\")-\u003eget();\n$clickup-\u003efolder()-\u003eget(\"FOLDER_ID\");\n$clickup-\u003efolder(\"SPACE_ID\")-\u003ecreate(\"FOLDER_NAME\");\n$clickup-\u003efolder(\"SPACE_ID\")-\u003ecreateList(\"LIST_NAME\");\n```\n\n### List\n```php\n$clickup-\u003etaskList(\"LIST_ID\")-\u003eget();\n$clickup-\u003etaskList(\"LIST_ID\")-\u003egetTasks();\n$clickup-\u003etaskList(\"LIST_ID\")-\u003ecomments();\n$clickup-\u003etaskList(\"LIST_ID\")-\u003emembers();\n$clickup-\u003etaskList(\"LIST_ID\")-\u003egetCustomFields();\n```\n\n### Task\n```php\n$clickup-\u003etask(\"TASK_ID\")-\u003eget();\n$clickup-\u003etask(\"TASK_ID\")-\u003ecomments();\n$clickup-\u003etask(\"TASK_ID\")-\u003emembers();\n\n$clickup-\u003etask(\"TASK_ID\")-\u003eadd([\n    \"name\": \"Updated Task Name\",\n    \"description\": \"Updated Task Content\",\n]);\n$clickup-\u003etask(\"TASK_ID\")-\u003edelete();\n$clickup-\u003etask(\"TASK_ID\")-\u003eupdate([\n    \"name\": \"Updated Task Name\",\n    \"description\": \"Updated Task Content\"\n]);\n\n$clickup-\u003etask(\"TASK_ID\")-\u003eaddAssignees([\n    MEMBER_ID_1,\n    MEMBER_ID_2,\n]);\n$clickup-\u003etask(\"TASK_ID\")-\u003eaddAssignee(MEMBER_ID);\n\n$attachment = new \\ClickUpClient\\Objects\\Attachment([\n    'contents' =\u003e \\GuzzleHttp\\Psr7\\Utils::tryFopen('FILE_PATH', 'r'),\n    'filename' =\u003e 'filename.txt'\n]);\n$clickup-\u003etask(\"TASK_ID\")-\u003eaddAttachment($attachment);\n\n$attachments = new \\ClickUpClient\\Objects\\AttachmentCollection([\n    [\n        'contents' =\u003e \\GuzzleHttp\\Psr7\\Utils::tryFopen('FILE_PATH', 'r'),\n        'filename' =\u003e 'filename1.txt'\n    ],\n    [\n        'contents' =\u003e \\GuzzleHttp\\Psr7\\Utils::tryFopen('FILE_PATH', 'r'),\n        'filename' =\u003e 'filename2.txt'\n    ],\n]);\n$clickup-\u003etask(\"TASK_ID\")-\u003eaddAttachments($attachments);\n$clickup-\u003etask(\"TASK_ID\")-\u003esetCustomField(\"FIELD_ID\",\"NEW_FIELD_VALUE\");\n$clickup-\u003etask(\"TASK_ID\")-\u003edeleteCustomField(\"FIELD_ID\");\n```\n\n### Comment\n```php\n$clickup-\u003ecomment('COMMENT_ID')-\u003eupdate([\n    'comment_text' =\u003e \"update comment text\"\n]);\n$clickup-\u003ecomment()-\u003edeleteComment('COMMENT_ID');\n```\n\n### Webhook\n```php\n$clickup-\u003eteam('TEAM_ID')-\u003ewebhooks();\n$clickup-\u003eteam('TEAM_ID')-\u003ecreateWebhook([\n    'endopint' =\u003e 'ENDPOINT_URL',\n    'events' =\u003e [\n        \"taskCreated\",\n        \"taskUpdated\",\n        \"taskDeleted\",\n    ],\n]);\n$clickup-\u003ewebhook('WEBHOOK_ID')-\u003eupdateWebhook([\n    'endopint' =\u003e 'ENDPOINT_URL',\n    'events' =\u003e [\n        \"taskCreated\",\n        \"taskUpdated\",\n        \"taskDeleted\",\n    ],\n]);\n$clickup-\u003ewebhook('WEBHOOK_ID')-\u003edelete();\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedsol%2Fphp-clickup-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedsol%2Fphp-clickup-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedsol%2Fphp-clickup-api-client/lists"}