{ "openapi": "3.0.0", "info": { "description": "Let's make people more productive, together.\n\nPlease use our [feedback board](https://clickup.canny.io) to report bugs, feature requests, and collaborate with the community.\n\nIf you'd like to import our entire API library, click [here](https://t333.s.clickup-attachments.com/t333/3bf59291-47c0-4f1a-ae91-5d9f26a8daca/ClickUp%20API%20V2.postman_collection.json) to download the file needed to import through Postman.\n\n## Authentication\n\nThere are two ways to authenticate with ClickUp API 2.0, with a personal token or creating an application and authenticating with an OAuth2 flow. Once you receive one of those two tokens, use that in the `Authorization` header of your API requests.\n\n**IMPORTANT** - _If you are creating an application for others to use, it is highly recommended that you use the OAuth2 flow._\n\n### Personal Token\n\nIf you are using the API for personal use, it is safe to use the personal API token. You can find this token in your user settings, under the `Apps` section. At the top of the page you have the option to generate a personal token. These tokens will always begin with `pk_`.\n\n![personal_token](https://attachments3.clickup.com/343f245e-7d27-411d-96d0-9ad3a6f2f8a7/personal_token.png)\n\nIf your token becomes compromised, you can regenerate it. However, be aware that any applications that were using the old token will lose access once it has been regenerated.\n\n### OAuth2 Flow\n\nWhen you want to develop an application that others can use, you must go through the OAuth2 flow so that every user that uses your application gets assigned an individualized token. This way each user of your application is able to access their own ClickUp resources. If you are unfamiliar with OAuth2, Digital Ocean has put together a great [guide](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2) that should get you started.\n\n***Note:** ClickUp uses the authorization code grant type.*\n\n#### How To Use the ClickUp OAuth2 Flow\n\n1. **Create An OAuth App** - As an admin, navigate to your team settings and click on the `Integrations` section. Once there, click on the icon that is labeled \"ClickUp API\" and create a new app. When you create an app, you will be prompted to enter a name, and at least one redirect url. When your app is created, you will be provided with a `client_id` and a `secret`.\n\n2. **Authorization Code** - You must first retrieve an authorization code from your user before you can get an access token for their account.\n - To start this process, redirect the user to `https://app.clickup.com/api?client_id={client_id}&redirect_uri={redirect_uri}` with the redirect query parameter set to a redirect uri that you specified when creating the oauth app. The host of the redirect uri must match one of those redirect uris or the request will fail. The protocol will default to https if not provided, and non-ssl redirect uris may not be supported in the future.\n - Once the user has accepted or rejected the authorization request, they will be redirected back to the `redirect_uri` with the necessary query parameters for getting an access token.\n\n3. **Access Token** - Once you have retrieved the authorization code in the previous step, you can then use the route `POST /api/v2/oauth/token` with the parameters `client_id`, `client_secret` , and `code` to get the user access token. This is the token that is used in the `Authorization` header for all requests in the ClickUp API. Skip to the authorization section below for more information on this route.\n\n4. **Token Teams** - When you redirect your user in step 2 of this flow, they will be prompted which teams (Workspaces) they want to grant you access to. Therefore in order to access a specific Workspace for the user, you need to ensure that they have given you access. You can use the route `GET /api/v2/team` to see which Workspaces they have authorized you to access. If they have not given you access to the appropriate Workspaces, you can redirect them to the authorization code URL from step 2 at any time to reauthorize your app. Below is a screenshot of what the user sees when they visit this URL.\n\n![token_teams](https://attachments3.clickup.com/49988c04-bf0f-42a5-96cc-82ce213b7f5e/token_teams.png)\n\n## Rate Limiting\n\nThe API is rate limited per OAuth and personal token. You will receive a 429 HTTP status code if you exceed the rate limit. The rate limit varies based on [plan](https://clickup.com/expandplans):\n\n- **Free Forever**, **Unlimited**, and **Business Plan**: 100 requests per minute per token\n\n- **Business Plus Plan**: 1,000 requests per minute per token\n\n- **Enterprise Plan**: 10,000 requests per minute per token\n\nLearn more about our [ClickUp Plans](https://clickup.com/pricing).\n\n## Error Handling\n\nErrors responses will return a non-200 status code and a json err message and error code.\n\nCommon errors include:\n\n**`Team not authorized`**: This error is thrown when a team was not authorized by the user for a particular access token. Refer to the `Token Teams` section of the OAuth instructions for more information on how to fix this error. Error codes that are associated with this message include `OAUTH_023`, `OAUTH_026`, `OAUTH_027`, and `OAUTH_029` to `OAUTH_045`\n\n**`Token not found`**: This error is thrown if authorization is revoked by the user, as described in the \"Personal Token\" section. Error codes that are associated with this message include `OAUTH_019`, `OAUTH_021`, `OAUTH_025`, and `OAUTH_077`\n\n**`Authorization Header Required`**: The authorization token was missing in the `Authorization` http header. `OAUTH_017`\n\n**`Client Not Found`**: The client application was not created correctly. `OAUTH_010`\n\n**`Redirect URI not passed`**: The redirect URI was not present during the OAuth authentication flow. Refer to the section \"Create An OAuth App\" to resolve this error. `OAUTH_017`\n\n**`Redirect URI does not match the redirect uris of this application`**: The redirect URI must be registered with your client application. Refer to the section \"Create An OAuth App\" to resolve this error. `OAUTH_007`\n\n## FAQ\n\n> What is `team` in reference to?\n\nTeams is the legacy term for what are now called Workspaces in ClickUp. For compatibility, the term `team` is still used in this API to refer to Workspaces. In our API documentation, `team_id` refers to the id of a Workspace, and `group_id` refers to the id of a user group.\n\n> What `Content-Type` should I use?\n\nWhen formatting your requests to ClickUp, please always use the content type `application/json`. Using form encoded data is not fully supported and can result in unexpected consequences.\n\n> How are projects and Folders related?\n\nProjects are what we used to call Folders in ClickUp V1. If you use the first version of the API, the items that are returned to you as projects are the same as Folders in the second version of the API. You must use the correct nomenclature depending on the version of the API you are using (`project` for V1 and `folder` for V2) and cannot interchange them.\n\n> Does the access token returned from `POST /api/v2/oauth/token` expire?\n\nThe access token does not expire at this time.\n\n> Is it possible to move a task between lists using the API?\n\nIt is not possible to move a task between lists at this time. This is a complicated process, however we hope to implement this on the public API in the near future.\n\n> Will tasks created via API generate notifications?\n\nYes, all actions you take with the public api will trigger all of the same process that would occur through the UI. This includes notifications, websocket messages, webhooks, etc.\n\n> How do I tell who has access to a particular task?\n\nTo get a list of team members that have access to a particular task or list, use the routes `GET /api/v2/task/{{task_id}}/member` and `GET /api/v2/list/{{list_id}}/member` under the \"Members\" section of this documentation.\n\n> How are dates formatted in ClickUp?\n\nClickUp will always display dates in [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds. You can use a website like [Epoch Converter](https://epochconverter.com) to convert dates between Unix and human readable date formats.\n\n> What timezone does your API use for timestamps?\n\nOur API always returns timestamps in [UTC (Coordinated Universal Time)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n\n> How are subtasks represented in the API?\n\nSubtasks are identical to tasks in every way. Therefore, you can manipulate subtasks the same way you would update any task with the API. To check if a task object is a subtask or not, locate the `parent` property. If this value is `null` then it is not a subtask, otherwise it will contain the task ID of the subtask's parent.\n\nTo create a subtask, use `POST /api/v2/list/:list_id/task` and make sure to set the `parent` property in the body of the request. Similarly, to update or delete existing subtasks, use the routes `PUT /api/v2/task/:task_id` and `DELETE /api/v2/task/:task_id` respectively. To fetch subtasks, get the parent task and add the subtask query param (`GET /api/v2/task/:parent_id?include_subtasks=true`) or use the search team route with that same query param (`GET /api/v2/team/:team_id/task?subtasks=true`).\n\n> The code examples shown here aren't working\n\nOur code examples are automatically generated and may require customization for specific coding languages and implementation. They are included for reference purposes only.", "title": "ClickUp 2.0", "version": "" }, "servers": [ { "url": "https://api.clickup.com/api/v2" } ], "paths": { "/checklist/{checklist_id}": { "delete": { "parameters": [ { "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", "example": "b955c4dc", "in": "path", "name": "checklist_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Checklist", "summary": "Delete Checklist" }, "put": { "parameters": [ { "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", "example": "b955c4dc", "in": "path", "name": "checklist_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Edit Checklist", "requestBody": { "content": { "application/json": { "schema": { "example": { "name": "Updated Checklist", "position": 1 }, "properties": { "name": { "type": "string" }, "position": { "type": "number" } }, "type": "object" } } } }, "summary": "Edit Checklist" } }, "/checklist/{checklist_id}/checklist_item": { "post": { "parameters": [ { "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", "example": "b955c4dc", "in": "path", "name": "checklist_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "checklist": { "date_created": "1567711563204", "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", "items": [ { "assignee": { "color": "#827718", "email": "example@email.com", "id": 183, "initials": "JD", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg", "username": "John Doe" }, "children": [], "date_created": "1567711566859", "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", "name": "Checklist Item", "orderindex": 0, "parent": null, "resolved": false } ], "name": "Checklist", "orderindex": 0, "resolved": 0, "task_id": "9hv", "unresolved": 1 } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Checklist Item", "requestBody": { "content": { "application/json": { "schema": { "example": { "assignee": 183, "name": "Checklist Item" }, "properties": { "assignee": { "type": "number" }, "name": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Checklist Item" } }, "/checklist/{checklist_id}/checklist_item/{checklist_item_id}": { "delete": { "parameters": [ { "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", "example": "b955c4dc", "in": "path", "name": "checklist_id", "required": true, "schema": { "type": "string" } }, { "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)", "example": "21e08dc8", "in": "path", "name": "checklist_item_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Checklist Item", "summary": "Delete Checklist Item" }, "put": { "parameters": [ { "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", "example": "b955c4dc", "in": "path", "name": "checklist_id", "required": true, "schema": { "type": "string" } }, { "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)", "example": "21e08dc8", "in": "path", "name": "checklist_item_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "checklist": { "date_created": "1567711563204", "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", "items": [ { "assignee": null, "children": [], "date_created": "1567711566859", "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", "name": "Updated Checklist Item", "orderindex": 0, "parent": null, "resolved": true } ], "name": "Checklist", "orderindex": 0, "resolved": 1, "task_id": "9hv", "unresolved": 0 } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Edit Checklist Item", "requestBody": { "content": { "application/json": { "schema": { "example": { "assignee": null, "name": "Updated Checklist Item", "parent": null, "resolved": true }, "properties": { "assignee": { "nullable": true }, "name": { "type": "string" }, "parent": { "nullable": true }, "resolved": { "type": "boolean" } }, "type": "object" } } } }, "summary": "Edit Checklist Item" } }, "/comment/{comment_id}": { "delete": { "parameters": [ { "description": "", "example": "456", "in": "path", "name": "comment_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Comment", "summary": "Delete Comment" }, "put": { "parameters": [ { "description": "", "example": "456", "in": "path", "name": "comment_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update Comment", "summary": "Update Comment" } }, "/folder/{folder_id}": { "delete": { "parameters": [ { "description": "", "example": "457", "in": "path", "name": "folder_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Folder", "summary": "Delete Folder" }, "get": { "parameters": [ { "description": "", "example": "457", "in": "path", "name": "folder_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "hidden": false, "id": "457", "lists": [], "name": "Updated Folder Name", "orderindex": 0, "override_statuses": false, "space": { "access": true, "id": "789", "name": "Space Name" }, "task_count": "0" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Folder", "summary": "Get Folder" }, "put": { "parameters": [ { "description": "", "example": "457", "in": "path", "name": "folder_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "hidden": false, "id": "457", "name": "Updated Folder Name", "orderindex": 0, "override_statuses": false, "space": { "access": true, "id": "789", "name": "Space Name" }, "task_count": "0" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update Folder", "requestBody": { "content": { "application/json": { "schema": { "example": { "name": "Updated Folder Name" }, "properties": { "name": { "type": "string" } }, "type": "object" } } } }, "summary": "Update Folder" } }, "/folder/{folder_id}/guest/{guest_id}": { "delete": { "parameters": [ { "description": "", "example": "1057", "in": "path", "name": "folder_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "guest_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "guest": { "can_edit_tags": true, "can_see_time_estimated": true, "can_see_time_spent": true, "invited_by": { "color": "#827718", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "shared": { "folders": [], "lists": [], "tasks": [] }, "user": { "color": null, "date_invited": "1583358383412", "date_joined": null, "email": "guest@example.com", "id": 184, "initials": "G", "last_active": null, "profilePicture": null, "role": 4, "username": null } } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Remove Guest From Folder", "summary": "Remove Guest From Folder" }, "post": { "parameters": [ { "description": "", "example": "1057", "in": "path", "name": "folder_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "guest_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "guest": { "can_edit_tags": true, "can_see_time_estimated": true, "can_see_time_spent": true, "invited_by": { "color": "#827718", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "shared": { "folders": [ { "archived": false, "hidden": false, "id": "1057", "lists": [], "name": "Folder Name", "orderindex": 5, "override_statuses": true, "permission_level": "read", "statuses": [ { "color": "#d3d3d3", "orderindex": 0, "status": "Open", "type": "open" }, { "color": "#6bc950", "orderindex": 5, "status": "Closed", "type": "closed" } ], "task_count": "20" } ], "lists": [], "tasks": [] }, "user": { "color": null, "date_invited": "1583358383412", "date_joined": null, "email": "guest@example.com", "id": 184, "initials": "G", "last_active": null, "profilePicture": null, "role": 4, "username": null } } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Add Guest To Folder", "requestBody": { "content": { "application/json": { "schema": { "example": { "permission_level": "read" }, "properties": { "permission_level": { "type": "string" } }, "type": "object" } } } }, "summary": "Add Guest To Folder" } }, "/folder/{folder_id}/list": { "get": { "parameters": [ { "description": "", "example": "456", "in": "path", "name": "folder_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "false", "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "lists": [ { "archived": false, "assignee": null, "content": "Updated List Content", "due_date": "1567780450202", "folder": { "access": true, "hidden": false, "id": "456", "name": "Folder Name" }, "id": "124", "name": "Updated List Name", "orderindex": 1, "override_statuses": false, "permission_level": "create", "priority": { "color": "#f50000", "priority": "high" }, "space": { "access": true, "id": "789", "name": "Space Name" }, "start_date": null, "status": { "color": "#e50000", "hide_label": true, "status": "red" }, "task_count": null }, { "archived": false, "assignee": null, "content": "Second List Content", "due_date": null, "folder": { "access": true, "hidden": false, "id": "456", "name": "Folder Name" }, "id": "125", "name": "Second List", "orderindex": 1, "override_statuses": false, "permission_level": "create", "priority": null, "space": { "access": true, "id": "789", "name": "Space Name" }, "start_date": null, "status": null, "task_count": null } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Lists", "summary": "Get Lists" }, "post": { "parameters": [ { "description": "", "example": "456", "in": "path", "name": "folder_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "assignee": { "color": "#827718", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "content": "New List Content", "due_date": "1567780450202", "due_date_time": false, "folder": { "access": true, "hidden": false, "id": "456", "name": "Folder Name" }, "id": "124", "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com", "name": "New List Name", "orderindex": 1, "priority": { "color": "#f50000", "priority": "urgent" }, "space": { "access": true, "id": "789", "name": "Space Name" }, "start_date": null, "start_date_time": null, "status": { "color": "#e50000", "hide_label": true, "status": "red" }, "statuses": [ { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" }, { "color": "#6bc950", "orderindex": 1, "status": "complete", "type": "closed" } ], "task_count": null } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create List", "requestBody": { "content": { "application/json": { "schema": { "example": { "assignee": 183, "content": "New List Content", "due_date": 1567780450202, "due_date_time": false, "name": "New List Name", "priority": 1, "status": "red" }, "properties": { "assignee": { "type": "number" }, "content": { "type": "string" }, "due_date": { "type": "number" }, "due_date_time": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "number" }, "status": { "type": "string" } }, "type": "object" } } } }, "summary": "Create List" } }, "/folder/{folder_id}/view": { "get": { "parameters": [ { "description": "", "example": "457", "in": "path", "name": "folder_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "views": [ { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-107", "name": "New Folder View Name", "parent": { "id": "457", "type": 5 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Folder Views", "summary": "Get Folder Views" }, "post": { "parameters": [ { "description": "", "example": "457", "in": "path", "name": "folder_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "view": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-107", "name": "New Folder View Name", "parent": { "id": "457", "type": 5 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Folder View", "requestBody": { "content": { "application/json": { "schema": { "example": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "name": "New Folder View Name", "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" }, "properties": { "columns": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "divide": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "nullable": true }, "field": { "nullable": true } }, "type": "object" }, "filters": { "properties": { "fields": { "items": {}, "type": "array" }, "op": { "type": "string" }, "search": { "type": "string" }, "show_closed": { "type": "boolean" } }, "type": "object" }, "grouping": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "type": "number" }, "field": { "type": "string" }, "ignore": { "type": "boolean" } }, "type": "object" }, "name": { "type": "string" }, "settings": { "properties": { "collapse_empty_columns": { "nullable": true }, "me_checklists": { "type": "boolean" }, "me_comments": { "type": "boolean" }, "me_subtasks": { "type": "boolean" }, "show_assignees": { "type": "boolean" }, "show_closed_subtasks": { "type": "boolean" }, "show_images": { "type": "boolean" }, "show_subtask_parent_names": { "type": "boolean" }, "show_subtasks": { "type": "number" }, "show_task_locations": { "type": "boolean" } }, "type": "object" }, "sorting": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "team_sidebar": { "properties": { "assigned_comments": { "type": "boolean" }, "assignees": { "items": {}, "type": "array" }, "unassigned_tasks": { "type": "boolean" } }, "type": "object" }, "type": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Folder View" } }, "/goal/{goal_id}": { "delete": { "parameters": [ { "description": "900e-462d-a849-4a216b06d930 (uuid)", "example": "e53a033c", "in": "path", "name": "goal_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Goal", "summary": "Delete Goal" }, "get": { "parameters": [ { "description": "900e-462d-a849-4a216b06d930 (uuid)", "example": "e53a033c", "in": "path", "name": "goal_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "goal": { "archived": false, "color": "#32a852", "creator": 183, "date_created": "1568044355026", "description": "Updated Goal Description", "due_date": "1568036964079", "folder_id": null, "history": [], "id": "e53a033c-900e-462d-a849-4a216b06d930", "key_results": [], "members": [], "multiple_owners": true, "name": "Updated Goal Name", "owners": [ { "color": "#827718", "email": "janedoe@gmail.com", "id": 182, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg", "username": "Jane Doe" } ], "percent_completed": 0, "pretty_id": "6", "pretty_url": "https://app.clickup.com/512/goals/6", "private": false, "start_date": null, "team_id": "512" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Goal", "summary": "Get Goal" }, "put": { "parameters": [ { "description": "900e-462d-a849-4a216b06d930 (uuid)", "example": "e53a033c", "in": "path", "name": "goal_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "goal": { "archived": false, "color": "#32a852", "creator": 183, "date_created": "1568044355026", "description": "Updated Goal Description", "due_date": "1568036964079", "folder_id": null, "history": [], "id": "e53a033c-900e-462d-a849-4a216b06d930", "key_results": [], "members": [], "multiple_owners": true, "name": "Updated Goal Name", "owners": [ { "color": "#827718", "email": "janedoe@gmail.com", "id": 182, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg", "username": "Jane Doe" } ], "percent_completed": 0, "pretty_id": "6", "pretty_url": "https://app.clickup.com/512/goals/6", "private": false, "start_date": null, "team_id": "512" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update Goal", "summary": "Update Goal" } }, "/goal/{goal_id}/key_result": { "post": { "parameters": [ { "description": "900e-462d-a849-4a216b06d930 (uuid)", "example": "e53a033c", "in": "path", "name": "goal_id", "required": true, "schema": { "type": "string" } }, { "description": "e.g. \"access_token\"", "example": "\"access_token\"", "in": "header", "name": "Authoriation", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "key_result": { "completed": false, "creator": 183, "date_created": "1568062902048", "goal_id": "e53a033c-900e-462d-a849-4a216b06d930", "goal_pretty_id": "6", "id": "947d46ed-8480-49bc-8c57-e569747efe93", "last_action": { "date_modified": "1568062902048", "id": "d3183d0f-5cbd-4158-b015-71465f1df269", "key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93", "note": "Created Key Result", "steps_before": null, "steps_current": null, "steps_taken": null, "userid": 183 }, "name": "New Key Result Name", "owners": [ { "color": "#827718", "email": "example@email.com", "id": 183, "initials": "JK", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg", "username": "John Doe" } ], "percent_completed": null, "subcategory_ids": [], "task_ids": [], "type": "number", "unit": "km" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Key Result", "requestBody": { "content": { "application/json": { "schema": { "example": { "list_ids": [], "name": "New Key Result Name", "owners": [ 183 ], "steps_end": 10, "steps_start": 0, "task_ids": [], "type": "number", "unit": "km" }, "properties": { "list_ids": { "items": {}, "type": "array" }, "name": { "type": "string" }, "owners": { "items": { "type": "number" }, "type": "array" }, "steps_end": { "type": "number" }, "steps_start": { "type": "number" }, "task_ids": { "items": {}, "type": "array" }, "type": { "type": "string" }, "unit": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Key Result" } }, "/group": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } }, { "description": "Enter one or more Team ids (user groups) to retrieve information about specific Teams.", "example": "C9C58BE9-7C73-4002-A6A9-310014852858", "in": "query", "name": "group_ids", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "groups": [ { "avatar": { "attachment_id": null, "color": null, "icon": null, "source": null }, "date_created": "1640122639829", "handle": "product", "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", "initials": "PT", "members": [ { "color": "#40BC86", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": null, "username": "Jerry" }, { "color": "#FF8600", "email": "sam@example.com", "id": 184, "initials": "S", "profilePicture": null, "username": "Sam" } ], "name": "product team", "team_id": "123456", "userid": 301123 }, { "avatar": { "attachment_id": null, "color": null, "icon": null, "source": null }, "date_created": "1627087990293", "handle": "hr-dept", "id": "fd31be63-41f2-4320-9043-9786fdf643d6", "initials": "HD", "members": [ { "color": "#40BC86", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" } ], "name": "HR department", "team_id": "301540", "userid": 301828 } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Teams", "summary": "Get Teams" } }, "/group/{group_id}": { "delete": { "parameters": [ { "description": "7C73-4002-A6A9-310014852858 (string) - Team ID (user group)", "example": "C9C58BE9", "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Team", "summary": "Delete Team" }, "put": { "parameters": [ { "description": "7C73-4002-A6A9-310014852858 (string) - Team ID (user group)", "example": "C9C58BE9", "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "avatar": { "attachment_id": null, "color": null, "icon": null, "source": null }, "date_created": "1640122639829", "handle": "newusergroupname", "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", "initials": "NN", "members": [ { "color": "#40BC86", "email": "jim@example.com", "id": 201, "initials": "JH", "profilePicture": null, "username": "Jim Halpert" }, { "color": "#FF8600", "email": "dwight@example.com", "id": 202, "initials": "DS", "profilePicture": null, "username": "Dwight Shrute" } ], "name": "New User Group Name", "team_id": "123456", "userid": 301828 } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update Team", "requestBody": { "content": { "application/json": { "schema": { "example": { "handle": "newusergroupname", "members": { "add": [ 123456, 987654 ], "rem": [ 159753 ] }, "name": "New User Group Name" }, "properties": { "handle": { "type": "string" }, "members": { "properties": { "add": { "items": { "type": "number" }, "type": "array" }, "rem": { "items": { "type": "number" }, "type": "array" } }, "type": "object" }, "name": { "type": "string" } }, "type": "object" } } } }, "summary": "Update Team" } }, "/key_result/{key_result_id}": { "delete": { "parameters": [ { "description": "8480-49bc-8c57-e569747efe93 (uuid)", "example": "947d46ed", "in": "path", "name": "key_result_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Key Result", "summary": "Delete Key Result" }, "put": { "parameters": [ { "description": "8480-49bc-8c57-e569747efe93 (uuid)", "example": "947d46ed", "in": "path", "name": "key_result_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "key_result": { "completed": false, "creator": 183, "date_created": "1568062902048", "goal_id": "e53a033c-900e-462d-a849-4a216b06d930", "goal_pretty_id": "6", "id": "947d46ed-8480-49bc-8c57-e569747efe93", "last_action": { "date_modified": "1568122776851", "id": "e889858b-a023-46cc-968a-cac32fd04c1e", "key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8", "note": "Target achieved", "steps_before": null, "steps_before_float": 0, "steps_current": null, "steps_current_float": null, "steps_taken": null, "steps_taken_float": 5, "userid": 183 }, "name": "New Key Result Name", "owners": [ { "color": "#827718", "email": "example@email.com", "id": 183, "initials": "JK", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg", "username": "John Doe" } ], "percent_completed": null, "subcategory_ids": [], "task_ids": [], "type": "number", "unit": "km" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Edit Key Result", "requestBody": { "content": { "application/json": { "schema": { "example": { "note": "Target achieved", "steps_current": 5 }, "properties": { "note": { "type": "string" }, "steps_current": { "type": "number" } }, "type": "object" } } } }, "summary": "Edit Key Result" } }, "/list/{list_id}": { "delete": { "parameters": [ { "description": "", "example": "124", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete List", "summary": "Delete List" }, "get": { "parameters": [ { "description": "", "example": "124", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "applicaton/json": { "examples": { "response": { "value": " {\n \"id\": \"124\",\n \"name\": \"Updated List Name\",\n \"orderindex\": 1,\n \"content\": \"Updated List Content\",\n \"status\": {\n \"status\": \"red\",\n \"color\": \"#e50000\",\n \"hide_label\": true\n },\n \"priority\": {\n \"priority\": \"high\",\n \"color\": \"#f50000\"\n },\n \"assignee\": null,\n \"task_count\": null,\n \"due_date\": \"1567780450202\",\n \"due_date_time\": true,\n \"start_date\": null,\n \"start_date_time\": null,\n \"folder\": {\n \"id\": \"456\",\n \"name\": \"Folder Name\",\n \"hidden\": false,\n \"access\": true\n },\n \"space\": {\n \"id\": \"789\",\n \"name\": \"Space Name\",\n \"access\": true\n },\n \"inbound_address\": \"add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com\",\n \"archived\": false,\n \"override_statuses\": false,\n \"statuses\": [\n {\n \"status\": \"to do\",\n \"orderindex\": 0,\n \"color\": \"#d3d3d3\",\n \"type\": \"open\"\n },\n {\n \"status\": \"complete\",\n \"orderindex\": 1,\n \"color\": \"#6bc950\",\n \"type\": \"closed\"\n }\n ],\n \"permission_level\": \"create\"\n }\n" } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get List", "summary": "Get List" }, "put": { "parameters": [ { "description": "", "example": "124", "in": "path", "name": "list_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "assignee": null, "content": "Updated List Content", "due_date": "1567780450202", "due_date_time": true, "folder": { "access": true, "hidden": false, "id": "456", "name": "Folder Name" }, "id": "124", "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com", "name": "Updated List Name", "orderindex": 1, "priority": { "color": "#f50000", "priority": "high" }, "space": { "access": true, "id": "789", "name": "Space Name" }, "start_date": null, "start_date_time": null, "status": { "color": "#e50000", "hide_label": true, "status": "red" }, "statuses": [ { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" }, { "color": "#6bc950", "orderindex": 1, "status": "complete", "type": "closed" } ], "task_count": null } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update List", "requestBody": { "content": { "application/json": { "schema": { "example": { "assignee": "none", "content": "Updated List Content", "due_date": 1567780450202, "due_date_time": true, "name": "Updated List Name", "priority": 2, "unset_status": true }, "properties": { "assignee": { "type": "string" }, "content": { "type": "string" }, "due_date": { "type": "number" }, "due_date_time": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "number" }, "unset_status": { "type": "boolean" } }, "type": "object" } } } }, "summary": "Update List" } }, "/list/{list_id}/comment": { "post": { "parameters": [ { "description": "", "example": "124", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "date": 1568037341249, "hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08", "id": "462" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create List Comment", "requestBody": { "content": { "application/json": { "schema": { "example": { "assignee": 183, "comment_text": "List comment content", "notify_all": true }, "properties": { "assignee": { "type": "number" }, "comment_text": { "type": "string" }, "notify_all": { "type": "boolean" } }, "type": "object" } } } }, "summary": "Create List Comment" } }, "/list/{list_id}/comment/": { "get": { "parameters": [ { "description": "", "example": "124", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } }, { "description": "Enter the `date` of a List info comment using Unix time in milliseconds", "in": "query", "name": "start", "required": false, "schema": { "type": "integer" } }, { "description": "Enter the Comment `id` of a List info comment", "in": "query", "name": "start_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "comments": [ { "assigned_by": { "color": "#827718", "email": "johndoe@gmail.com", "id": 183, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" }, "assignee": { "color": "#827718", "email": "johndoe@gmail.com", "id": 183, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" }, "comment": [ { "text": "List comment content" } ], "comment_text": "List comment content", "date": "1568036964079", "id": "462", "reactions": [], "resolved": false, "user": { "color": "#827718", "email": "johndoe@gmail.com", "id": 183, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" } } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get List Comments", "summary": "Get List Comments" } }, "/list/{list_id}/field": { "get": { "parameters": [ { "description": "", "example": "123", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "fields": [ { "date_created": "1566400407303", "hide_from_guests": false, "id": "03efda77-c7a0-42d3-8afd-fd546353c2f5", "name": "Text Field", "type": "text", "type_config": {} }, { "date_created": "1565993269460", "hide_from_guests": false, "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", "name": "Number Field", "type": "number", "type_config": {} }, { "date_created": "1558567802303", "hide_from_guests": false, "id": "0c7e8f5c-557b-4128-bf37-29e2fe5bb7f9", "name": "Label Field", "type": "labels", "type_config": { "options": [ { "color": null, "id": "fb332c98-d7bc-4ee8-a3bd-b5ffaff98c3c", "label": "one" }, { "color": null, "id": "2b0c058c-2f41-4f61-8fc8-f9ea426e8c0e", "label": "two" }, { "color": null, "id": "75e10f4b-b4cc-4ef9-94dc-230d19ef4fa6", "label": "three" } ] } }, { "date_created": "1562944066529", "hide_from_guests": false, "id": "10916331-1903-4026-886f-891f29aa9fb6", "name": "Checkbox Field", "type": "checkbox", "type_config": {} }, { "date_created": "1565886951888", "hide_from_guests": false, "id": "2e3d4145-9a54-4d0a-9446-78ba595b327f", "name": "Date Field", "type": "date", "type_config": {} }, { "date_created": "1565962775482", "hide_from_guests": false, "id": "31b84286-635a-45fd-bbd5-3814fbbb08bb", "name": "User Field", "type": "users", "type_config": {} }, { "date_created": "1565993263347", "hide_from_guests": false, "id": "5cf8a44f-4421-4982-97d7-3e2209be2df4", "name": "Currency Field", "type": "currency", "type_config": { "currency_type": "USD", "default": null, "precision": 2 } }, { "date_created": "1563545189836", "hide_from_guests": false, "id": "790e5051-7923-43e8-8f05-2e4940557bd8", "name": "Phone Field", "type": "phone", "type_config": {} }, { "date_created": "1565993237778", "hide_from_guests": false, "id": "8551901a-3eca-4193-b691-e0e3c9f94ff3", "name": "Drop Down Field", "type": "drop_down", "type_config": { "default": 0, "options": [ { "color": null, "id": "5f6ce650-cb1d-437d-8373-72578a092510", "name": "1", "orderindex": 0, "type": "numeric", "value": 1 }, { "color": null, "id": "89707879-c4e1-44b9-9cc0-be7c16ee6681", "name": "2", "orderindex": 1, "type": "numeric", "value": 2 } ], "placeholder": null } }, { "date_created": "1565993299379", "hide_from_guests": false, "id": "9b45e079-f647-4556-bdd9-a7589ccd2530", "name": "Manual Progress Field", "type": "manual_progress", "type_config": { "end": 100, "start": 0 } }, { "date_created": "1565993309955", "hide_from_guests": false, "id": "b5be3c35-4fe1-429e-affe-4318de213efe", "name": "Emoji (Rating) Field", "type": "emoji", "type_config": { "code_point": "1f383", "count": 5 } }, { "date_created": "1566405066706", "hide_from_guests": false, "id": "ba0d56f6-f1ba-4015-b726-12c013bb8ac6", "name": "Automatic Progress Field", "type": "automatic_progress", "type_config": { "complete_on": 3, "tracking": { "assigned_comments": true, "checklists": true, "subtasks": true } } }, { "date_created": "1565993242649", "hide_from_guests": false, "id": "decb4a8a-6120-46b0-9cbb-66f3ee1de3c5", "name": "Email Field", "type": "email", "type_config": {} }, { "date_created": "1559001282914", "hide_from_guests": false, "id": "e438e267-4f9f-4b54-b937-cbdb0e0369dd", "name": "URL Field", "type": "url", "type_config": {} } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Accessible Custom Fields", "summary": "Get Accessible Custom Fields" } }, "/list/{list_id}/guest/{guest_id}": { "delete": { "parameters": [ { "description": "", "example": "1427", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "guest_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "guest": { "can_edit_tags": true, "can_see_time_estimated": true, "can_see_time_spent": true, "invited_by": { "color": "#827718", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "shared": { "folders": [], "lists": [], "tasks": [] }, "user": { "color": null, "date_invited": "1583358383412", "date_joined": null, "email": "guest@example.com", "id": 184, "initials": "G", "last_active": null, "profilePicture": null, "role": 4, "username": null } } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Remove Guest From List", "summary": "Remove Guest From List" }, "post": { "parameters": [ { "description": "", "example": "1427", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "guest_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "guest": { "can_edit_tags": true, "can_see_time_estimated": true, "can_see_time_spent": true, "invited_by": { "color": "#827718", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "shared": { "folders": [], "lists": [ { "archived": false, "assignee": null, "due_date": null, "id": "1427", "name": "List Name", "orderindex": 1, "override_statuses": true, "permission_level": "read", "priority": null, "start_date": null, "status": null, "statuses": [ { "color": "#d3d3d3", "orderindex": 0, "status": "Open", "type": "open" }, { "color": "#6bc950", "orderindex": 5, "status": "Closed", "type": "closed" } ], "task_count": "5" } ], "tasks": [] }, "user": { "color": null, "date_invited": "1583358383412", "date_joined": null, "email": "guest@example.com", "id": 184, "initials": "G", "last_active": null, "profilePicture": null, "role": 4, "username": null } } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Add Guest To List", "requestBody": { "content": { "application/json": { "schema": { "example": { "permission_level": "read" }, "properties": { "permission_level": { "type": "string" } }, "type": "object" } } } }, "summary": "Add Guest To List" } }, "/list/{list_id}/member": { "get": { "parameters": [ { "description": "", "example": "123", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "members": [ { "color": "#FFFFFF", "email": "john@example.com", "id": 812, "initials": "JD", "profileInfo": { "display_profile": null, "top_tier_user": null, "verified_ambassador": null, "verified_consultant": null, "viewed_top_tier_user": null, "viewed_verified_ambassador": null, "viewed_verified_consultant": null }, "profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg", "username": "John Doe" }, { "color": null, "email": "jane@example.com", "id": 813, "initials": "JD", "profileInfo": { "display_profile": null, "top_tier_user": null, "verified_ambassador": null, "verified_consultant": null, "viewed_top_tier_user": null, "viewed_verified_ambassador": null, "viewed_verified_consultant": null }, "profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg", "username": "Jane Doe" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get List Members", "summary": "Get List Members" } }, "/list/{list_id}/task": { "get": { "parameters": [ { "description": "", "example": "123", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "false", "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" } }, { "description": "Page to fetch (starts at 0)", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Order by field, defaults to created\n Options: id, created, updated, due_date\n", "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "description": "Reverse order", "in": "query", "name": "reverse", "required": false, "schema": { "type": "boolean" } }, { "description": "Include subtasks, default false", "in": "query", "name": "subtasks", "required": false, "schema": { "type": "boolean" } }, { "description": "Statuses to query", "in": "query", "name": "statuses%5B%5D", "required": false, "schema": { "type": "array" } }, { "description": "By default, the api does not include closed tasks. Set this to true and dont send a status filter to include closed tasks.", "in": "query", "name": "include_closed", "required": false, "schema": { "type": "boolean" } }, { "description": "Assignees to query", "in": "query", "name": "assignees%5B%5D", "required": false, "schema": { "type": "array" } }, { "description": "Filter due date greater than Unix time in milliseconds", "in": "query", "name": "due_date_gt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter due date less than Unix time in milliseconds", "in": "query", "name": "due_date_lt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter date created greater than Unix time in milliseconds", "in": "query", "name": "date_created_gt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter date created less than Unix time in milliseconds", "in": "query", "name": "date_created_lt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter date updated greater than Unix time in milliseconds", "in": "query", "name": "date_updated_gt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter date updated less than Unix time in milliseconds", "in": "query", "name": "date_updated_lt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter by Custom Fields. Must be a stringified JSON array of objects that must include fields `field_id`, `value`, `operator`.\n\n+ See the **Custom Fields** reference page on the lefthand side for additional information on valid input for fields `value` and `field_id` for different _types_ of Custom Fields\n\n+ Accepted Values for `operator`: `=`, `<`, `<=`, `>`, `>=`, `!=`, `IS NULL` ,`IS NOT NULL` ,`RANGE`, `ANY`, `ALL`, `NOT ANY`, `NOT ALL`\n\n+ Example: `?custom_fields=[{\"field_id\":\"de761538-8ae0-42e8-91d9-f1a0cdfbd8b5\",\"operator\":\">\",\"value\":2},{...}]`", "in": "query", "name": "custom_fields%5B%5D", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Tasks", "summary": "Get Tasks" }, "post": { "parameters": [ { "description": "", "example": "123", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Task", "requestBody": { "content": { "application/json": { "schema": { "example": { "tags": [ "tag name 1" ], "assignees": [ 183 ], "check_required_custom_fields": true, "custom_fields": [ { "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", "value": 23 }, { "id": "03efda77-c7a0-42d3-8afd-fd546353c2f5", "value": "Text field input" } ], "description": "New Task Description", "due_date": 1508369194377, "due_date_time": false, "links_to": null, "name": "New Task Name", "notify_all": true, "parent": null, "priority": 3, "start_date": 1567780450202, "start_date_time": false, "status": "Open", "time_estimate": 8640000 }, "properties": { "tags": { "items": { "type": "string" }, "type": "array" }, "assignees": { "items": { "type": "number" }, "type": "array" }, "check_required_custom_fields": { "type": "boolean" }, "custom_fields": { "items": { "properties": { "id": { "type": "string" }, "value": { "oneOf": [ { "type": "number" }, { "type": "string" } ] } }, "required": [ "id", "value" ], "type": "object" }, "type": "array" }, "description": { "type": "string" }, "due_date": { "type": "number" }, "due_date_time": { "type": "boolean" }, "links_to": { "nullable": true }, "name": { "type": "string" }, "notify_all": { "type": "boolean" }, "parent": { "nullable": true }, "priority": { "type": "number" }, "start_date": { "type": "number" }, "start_date_time": { "type": "boolean" }, "status": { "type": "string" }, "time_estimate": { "type": "number" } }, "type": "object" } } } }, "summary": "Create Task" } }, "/list/{list_id}/task/{task_id}": { "delete": { "parameters": [ { "description": "", "example": "123", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "9hz", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Remove Task From List", "summary": "Remove Task From List" }, "post": { "parameters": [ { "description": "", "example": "123", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "9hz", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Add Task To List", "summary": "Add Task To List" } }, "/list/{list_id}/taskTemplate/{template_id}": { "post": { "parameters": [ { "description": "", "example": "512", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "9hz", "in": "path", "name": "template_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Task From Template", "requestBody": { "content": { "application/json": { "schema": { "example": { "name": "New task name" }, "properties": { "name": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Task From Template" } }, "/list/{list_id}/view": { "get": { "parameters": [ { "description": "", "example": "124", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "views": [ { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-107", "name": "New List View Name", "parent": { "id": "124", "type": 6 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get List Views", "summary": "Get List Views" }, "post": { "parameters": [ { "description": "", "example": "124", "in": "path", "name": "list_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "view": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-108", "name": "New List View Name", "parent": { "id": "124", "type": 6 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create List View", "requestBody": { "content": { "application/json": { "schema": { "example": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "name": "New List View Name", "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" }, "properties": { "columns": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "divide": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "nullable": true }, "field": { "nullable": true } }, "type": "object" }, "filters": { "properties": { "fields": { "items": {}, "type": "array" }, "op": { "type": "string" }, "search": { "type": "string" }, "show_closed": { "type": "boolean" } }, "type": "object" }, "grouping": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "type": "number" }, "field": { "type": "string" }, "ignore": { "type": "boolean" } }, "type": "object" }, "name": { "type": "string" }, "settings": { "properties": { "collapse_empty_columns": { "nullable": true }, "me_checklists": { "type": "boolean" }, "me_comments": { "type": "boolean" }, "me_subtasks": { "type": "boolean" }, "show_assignees": { "type": "boolean" }, "show_closed_subtasks": { "type": "boolean" }, "show_images": { "type": "boolean" }, "show_subtask_parent_names": { "type": "boolean" }, "show_subtasks": { "type": "number" }, "show_task_locations": { "type": "boolean" } }, "type": "object" }, "sorting": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "team_sidebar": { "properties": { "assigned_comments": { "type": "boolean" }, "assignees": { "items": {}, "type": "array" }, "unassigned_tasks": { "type": "boolean" } }, "type": "object" }, "type": { "type": "string" } }, "type": "object" } } } }, "summary": "Create List View" } }, "/oauth/token": { "post": { "parameters": [ { "description": "Oauth app client id", "in": "query", "name": "client_id", "required": true, "schema": { "type": "string" } }, { "description": "Oauth app client secret", "in": "query", "name": "client_secret", "required": true, "schema": { "type": "string" } }, { "description": "Code given in redirect url", "in": "query", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "access_token": "access token" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Access Token", "summary": "Get Access Token" } }, "/space/{space_id}": { "delete": { "parameters": [ { "description": "", "example": "790", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Space", "summary": "Delete Space" }, "get": { "parameters": [ { "description": "", "example": "790", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "features": { "tags": { "enabled": false }, "checklists": { "enabled": true }, "custom_fields": { "enabled": true }, "dependency_warning": { "enabled": false }, "due_dates": { "enabled": false, "remap_closed_due_date": false, "remap_due_dates": false, "start_date": false }, "portfolios": { "enabled": false }, "remap_dependencies": { "enabled": false }, "time_estimates": { "enabled": false }, "time_tracking": { "enabled": false } }, "id": "790", "multiple_assignees": false, "name": "Updated Space Name", "private": false, "statuses": [ { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" }, { "color": "#6bc950", "orderindex": 1, "status": "complete", "type": "closed" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Space", "summary": "Get Space" }, "put": { "parameters": [ { "description": "", "example": "790", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "features": { "tags": { "enabled": false }, "checklists": { "enabled": true }, "custom_fields": { "enabled": true }, "dependency_warning": { "enabled": false }, "due_dates": { "enabled": false, "remap_closed_due_date": false, "remap_due_dates": false, "start_date": false }, "portfolios": { "enabled": false }, "remap_dependencies": { "enabled": false }, "time_estimates": { "enabled": false }, "time_tracking": { "enabled": false } }, "id": "790", "multiple_assignees": false, "name": "Updated Space Name", "private": false, "statuses": [ { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" }, { "color": "#6bc950", "orderindex": 1, "status": "complete", "type": "closed" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update Space", "requestBody": { "content": { "application/json": { "schema": { "example": { "features": { "tags": { "enabled": false }, "checklists": { "enabled": true }, "custom_fields": { "enabled": true }, "dependency_warning": { "enabled": false }, "due_dates": { "enabled": false, "remap_closed_due_date": false, "remap_due_dates": false, "start_date": false }, "portfolios": { "enabled": false }, "remap_dependencies": { "enabled": false }, "time_estimates": { "enabled": false }, "time_tracking": { "enabled": false } }, "multiple_assignees": false, "name": "Updated Space Name" }, "properties": { "features": { "properties": { "tags": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "checklists": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "custom_fields": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "dependency_warning": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "due_dates": { "properties": { "enabled": { "type": "boolean" }, "remap_closed_due_date": { "type": "boolean" }, "remap_due_dates": { "type": "boolean" }, "start_date": { "type": "boolean" } }, "type": "object" }, "portfolios": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "remap_dependencies": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "time_estimates": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "time_tracking": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "multiple_assignees": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" } } } }, "summary": "Update Space" } }, "/space/{space_id}/folder": { "get": { "parameters": [ { "description": "", "example": "789", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "false", "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": [ { "hidden": false, "id": "457", "lists": [], "name": "Updated Folder Name", "orderindex": 0, "override_statuses": false, "space": { "access": true, "id": "789", "name": "Space Name" }, "task_count": "0" }, { "hidden": false, "id": "458", "lists": [], "name": "Second Folder Name", "orderindex": 1, "override_statuses": false, "space": { "access": true, "id": "789", "name": "Space Name" }, "task_count": "0" } ] } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Folders", "summary": "Get Folders" }, "post": { "parameters": [ { "description": "", "example": "789", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "hidden": false, "id": "457", "name": "New Folder Name", "orderindex": 0, "override_statuses": false, "space": { "access": true, "id": "789", "name": "Space Name" }, "task_count": "0" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Folder", "requestBody": { "content": { "application/json": { "schema": { "example": { "name": "New Folder Name" }, "properties": { "name": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Folder" } }, "/space/{space_id}/list": { "get": { "parameters": [ { "description": "", "example": "789", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "false", "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "lists": [ { "archived": false, "assignee": null, "content": "Updated List Content", "due_date": "1567780450202", "folder": { "access": true, "hidden": true, "id": "457", "name": "hidden" }, "id": "124", "name": "Updated List Name", "orderindex": 1, "override_statuses": false, "permission_level": "create", "priority": { "color": "#f50000", "priority": "high" }, "space": { "access": true, "id": "789", "name": "Space Name" }, "start_date": null, "status": { "color": "#e50000", "hide_label": true, "status": "red" }, "task_count": null }, { "archived": false, "assignee": null, "content": "Second List Content", "due_date": null, "folder": { "access": true, "hidden": true, "id": "457", "name": "hidden" }, "id": "125", "name": "Second List", "orderindex": 1, "override_statuses": false, "permission_level": "create", "priority": null, "space": { "access": true, "id": "789", "name": "Space Name" }, "start_date": null, "status": null, "task_count": null } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Folderless Lists", "summary": "Get Folderless Lists" }, "post": { "parameters": [ { "description": "", "example": "789", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "assignee": { "color": "#827718", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "content": "New List Content", "due_date": "1567780450202", "due_date_time": false, "folder": { "access": true, "hidden": true, "id": "457", "name": "hidden" }, "id": "124", "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com", "name": "New List Name", "orderindex": 1, "priority": { "color": "#f50000", "priority": "urgent" }, "space": { "access": true, "id": "789", "name": "Space Name" }, "start_date": null, "start_date_time": null, "status": { "color": "#e50000", "hide_label": true, "status": "red" }, "statuses": [ { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" }, { "color": "#6bc950", "orderindex": 1, "status": "complete", "type": "closed" } ], "task_count": null } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Folderless List", "requestBody": { "content": { "application/json": { "schema": { "example": { "assignee": 183, "content": "New List Content", "due_date": 1567780450202, "due_date_time": false, "name": "New List Name", "priority": 1, "status": "red" }, "properties": { "assignee": { "type": "number" }, "content": { "type": "string" }, "due_date": { "type": "number" }, "due_date_time": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "number" }, "status": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Folderless List" } }, "/space/{space_id}/tag": { "get": { "parameters": [ { "description": "", "example": "512", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "tags": [ { "name": "Tag name", "tag_bg": "#000000", "tag_fg": "#000000" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Space Tags", "summary": "Get Space Tags" }, "post": { "parameters": [ { "description": "", "example": "512", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Space Tag", "requestBody": { "content": { "application/json": { "schema": { "example": { "tag": { "name": "Tag Name", "tag_bg": "#000000", "tag_fg": "#000000" } }, "properties": { "tag": { "properties": { "name": { "type": "string" }, "tag_bg": { "type": "string" }, "tag_fg": { "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "summary": "Create Space Tag" } }, "/space/{space_id}/tag/{tag_name}": { "delete": { "parameters": [ { "description": "", "example": "512", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "name", "in": "path", "name": "tag_name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Space Tag", "requestBody": { "content": { "application/json": { "schema": { "example": { "tag": { "name": "Tag name", "tag_bg": "#000000", "tag_fg": "#000000" } }, "properties": { "tag": { "properties": { "name": { "type": "string" }, "tag_bg": { "type": "string" }, "tag_fg": { "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "summary": "Delete Space Tag" }, "put": { "parameters": [ { "description": "", "example": "512", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "name", "in": "path", "name": "tag_name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "tag": { "bg_color": "#ffffff", "fg_color": "#ffffff", "name": "Updated Tag" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Edit Space Tag", "summary": "Edit Space Tag" } }, "/space/{space_id}/view": { "get": { "parameters": [ { "description": "", "example": "790", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "views": [ { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-106", "name": "New Space View Name", "parent": { "id": "790", "type": 4 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Space Views", "summary": "Get Space Views" }, "post": { "parameters": [ { "description": "", "example": "790", "in": "path", "name": "space_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "view": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-106", "name": "New Space View Name", "parent": { "id": "790", "type": 4 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Space View", "requestBody": { "content": { "application/json": { "schema": { "example": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "name": "New Space View Name", "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" }, "properties": { "columns": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "divide": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "nullable": true }, "field": { "nullable": true } }, "type": "object" }, "filters": { "properties": { "fields": { "items": {}, "type": "array" }, "op": { "type": "string" }, "search": { "type": "string" }, "show_closed": { "type": "boolean" } }, "type": "object" }, "grouping": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "type": "number" }, "field": { "type": "string" }, "ignore": { "type": "boolean" } }, "type": "object" }, "name": { "type": "string" }, "settings": { "properties": { "collapse_empty_columns": { "nullable": true }, "me_checklists": { "type": "boolean" }, "me_comments": { "type": "boolean" }, "me_subtasks": { "type": "boolean" }, "show_assignees": { "type": "boolean" }, "show_closed_subtasks": { "type": "boolean" }, "show_images": { "type": "boolean" }, "show_subtask_parent_names": { "type": "boolean" }, "show_subtasks": { "type": "number" }, "show_task_locations": { "type": "boolean" } }, "type": "object" }, "sorting": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "team_sidebar": { "properties": { "assigned_comments": { "type": "boolean" }, "assignees": { "items": {}, "type": "array" }, "unassigned_tasks": { "type": "boolean" } }, "type": "object" }, "type": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Space View" } }, "/task/bulk_time_in_status/task_ids/": { "get": { "parameters": [ { "description": "Pass in multiple `task_ids` parameters with different task ids to query for multiple tasks' time in status\n\n+ Example: `task_ids=3cuh&task_ids=g4fs& ...`", "in": "query", "name": "task_ids", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "20bbn28": { "current_status": { "color": "#d3d3d3", "status": "open", "total_time": { "by_minute": 21830, "since": "1604004420925" } }, "status_history": [ { "color": "#d3d3d3", "orderindex": 0, "status": "open", "total_time": { "by_minute": 22276, "since": "1604004420925" }, "type": "open" }, { "color": "#5CF1D4", "orderindex": 4, "status": "active status #2", "total_time": { "by_minute": 40109, "since": "1601597828835" }, "type": "custom" } ] }, "27075wz": { "current_status": { "color": "#d3d3d3", "status": "open", "total_time": { "by_minute": 21830, "since": "1604004423494" } }, "status_history": [ { "color": "#d3d3d3", "orderindex": 0, "status": "open", "total_time": { "by_minute": 21829, "since": "1604004423494" }, "type": "open" }, { "color": "#5CF1D4", "orderindex": 4, "status": "active status #2", "total_time": { "by_minute": 23274, "since": "1602607941692" }, "type": "custom" } ] } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Bulk Tasks' Time in Status", "summary": "Get Bulk Tasks' Time in Status" } }, "/task/{task_id}/": { "delete": { "parameters": [ { "description": "", "example": "9xh", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Task", "summary": "Delete Task" }, "get": { "parameters": [ { "description": "", "example": "9hz", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } }, { "description": "Include subtasks, default false", "in": "query", "name": "include_subtasks", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Task", "summary": "Get Task" }, "put": { "parameters": [ { "description": "", "example": "9hx", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "tags": [], "archived": false, "assignees": [], "checklists": [], "creator": { "color": "#827718", "id": 183, "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" }, "custom_fields": [ { "date_created": "1622176979540", "hide_from_guests": false, "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", "name": "My Number field", "required": true, "type": "checkbox", "type_config": {}, "value": "23" }, { "date_created": "1622176979540", "hide_from_guests": false, "id": "03efda77-c7a0-42d3-8afd-fd546353c2f5", "name": "My Text field", "required": false, "type": "short_text", "type_config": {}, "value": "Text field input" }, { "date_created": "1618440378816", "hide_from_guests": false, "id": "f4d2a20d-6759-4420-b853-222dbe2589d5", "name": "My People", "required": false, "type": "users", "type_config": { "include_groups": true, "include_guests": true, "include_team_members": true, "single_user": true } } ], "custom_id": null, "date_closed": null, "date_created": "1567780450202", "date_updated": "1567780450202", "description": "Updated Task Content", "due_date": null, "folder": { "id": "456" }, "id": "9hx", "list": { "id": "123" }, "name": "Updated Task Name", "orderindex": "1.00000000000000000000000000000000", "parent": null, "priority": null, "space": { "id": "789" }, "start_date": null, "status": { "color": "#d3d3d3", "orderindex": 1, "status": "in progress", "type": "custom" }, "text_content": "Updated Task Content", "time_estimate": null, "time_spent": null, "url": "https://app.clickup.com/t/9hx" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update Task", "requestBody": { "content": { "application/json": { "schema": { "example": { "archived": false, "assignees": { "add": [ 182 ], "rem": [ 183 ] }, "description": "Updated Task Content", "name": "Updated Task Name", "priority": 1, "status": "in progress", "time_estimate": 8640000 }, "properties": { "archived": { "type": "boolean" }, "assignees": { "properties": { "add": { "items": { "type": "number" }, "type": "array" }, "rem": { "items": { "type": "number" }, "type": "array" } }, "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "number" }, "status": { "type": "string" }, "time_estimate": { "type": "number" } }, "type": "object" } } } }, "summary": "Update Task" } }, "/task/{task_id}/attachment": { "post": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "date": 1569988578766, "extension": "png", "id": "ac434d4e-8b1c-4571-951b-866b6d9f2ee6.png", "thumbnail_large": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png", "thumbnail_small": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png", "title": "image.png", "url": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png", "version": "0" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Task Attachment", "summary": "Create Task Attachment" } }, "/task/{task_id}/checklist/": { "post": { "parameters": [ { "description": "", "example": "9hz", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "checklist": { "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", "items": [], "name": "Checklist", "orderindex": 0, "resolved": 0, "task_id": "9hz", "unresolved": 0 } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Checklist", "requestBody": { "content": { "application/json": { "schema": { "example": { "name": "Checklist" }, "properties": { "name": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Checklist" } }, "/task/{task_id}/comment": { "post": { "parameters": [ { "description": "", "example": "9hz", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "date": 1568036964079, "hist_id": "26508", "id": "458" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Task Comment", "requestBody": { "content": { "application/json": { "schema": { "example": { "assignee": 183, "comment_text": "Task comment content", "notify_all": true }, "properties": { "assignee": { "type": "number" }, "comment_text": { "type": "string" }, "notify_all": { "type": "boolean" } }, "type": "object" } } } }, "summary": "Create Task Comment" } }, "/task/{task_id}/comment/": { "get": { "parameters": [ { "description": "", "example": "9hz", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } }, { "description": "Enter the `date` of a task comment using Unix time in milliseconds", "in": "query", "name": "start", "required": false, "schema": { "type": "integer" } }, { "description": "Enter the Comment `id` of a task comment", "in": "query", "name": "start_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "comments": [ { "assigned_by": { "color": "#827718", "email": "johndoe@gmail.com", "id": 183, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" }, "assignee": { "color": "#827718", "email": "johndoe@gmail.com", "id": 183, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" }, "comment": [ { "text": "Task comment content" } ], "comment_text": "Task comment content", "date": "1568036964079", "id": "458", "reactions": [], "resolved": false, "user": { "color": "#827718", "email": "johndoe@gmail.com", "id": 183, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" } } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Task Comments", "summary": "Get Task Comments" } }, "/task/{task_id}/dependency": { "delete": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "9hz", "in": "query", "name": "depends_on", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "9hz", "in": "query", "name": "dependency_of", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Dependency", "summary": "Delete Dependency" } }, "/task/{task_id}/dependency/": { "post": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Add Dependency", "summary": "Add Dependency" } }, "/task/{task_id}/field/{field_id}/": { "delete": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", "example": "b955c4dc", "in": "path", "name": "field_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Remove Custom Field Value", "summary": "Remove Custom Field Value" }, "post": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", "example": "b955c4dc", "in": "path", "name": "field_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Set Custom Field Value", "requestBody": { "content": { "application/json": { "schema": { "example": { "value": 80 }, "properties": { "value": { "type": "number" } }, "type": "object" } } } }, "summary": "Set Custom Field Value" } }, "/task/{task_id}/guest/{guest_id}/": { "delete": { "parameters": [ { "description": "", "example": "c04", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "403", "in": "path", "name": "guest_id", "required": true, "schema": { "type": "number" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "guest": { "can_edit_tags": true, "can_see_time_estimated": true, "can_see_time_spent": true, "invited_by": { "color": "#827718", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "shared": { "folders": [], "lists": [], "tasks": [] }, "user": { "color": null, "date_invited": "1583358383412", "date_joined": null, "email": "guest@example.com", "id": 184, "initials": "G", "last_active": null, "profilePicture": null, "role": 4, "username": null } } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Remove Guest From Task", "summary": "Remove Guest From Task" }, "post": { "parameters": [ { "description": "", "example": "c04", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "403", "in": "path", "name": "guest_id", "required": true, "schema": { "type": "number" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "guest": { "can_edit_tags": true, "can_see_time_estimated": true, "can_see_time_spent": true, "invited_by": { "color": "#827718", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "shared": { "folders": [], "lists": [], "tasks": [ { "tags": [], "archived": false, "assignees": [], "checklists": [], "creator": { "color": "#827718", "id": 183, "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "custom_fields": [], "date_closed": null, "date_created": "1574718405408", "date_updated": "1574722145869", "dependencies": [], "due_date": "1508369194377", "folder": { "access": false, "hidden": false, "id": "1217", "name": "Shared with me" }, "id": "c04", "list": { "access": false, "id": "1752", "name": "Shared with me" }, "name": "Task Name", "orderindex": "0", "parent": null, "permission_level": "read", "points": null, "priority": { "color": "#f50000", "id": "1", "orderindex": "1", "priority": "urgent" }, "space": { "id": "380" }, "start_date": null, "status": { "color": "#d3d3d3", "orderindex": 0, "status": "Open", "type": "open" }, "team_id": "108", "time_estimate": null, "url": "https://app.clickup.com/t/c04" } ] }, "user": { "color": null, "date_invited": "1583358383412", "date_joined": null, "email": "guest@example.com", "id": 184, "initials": "G", "last_active": null, "profilePicture": null, "role": 4, "username": null } } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Add Guest To Task", "requestBody": { "content": { "application/json": { "schema": { "example": { "permission_level": "read" }, "properties": { "permission_level": { "type": "string" } }, "type": "object" } } } }, "summary": "Add Guest To Task" } }, "/task/{task_id}/link/{links_to}/": { "delete": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "9hz", "in": "path", "name": "links_to", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "task": { "tags": [], "assignees": [], "checklists": [], "creator": { "color": "#827718", "id": 183, "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" }, "date_closed": null, "date_created": "1567780450202", "date_updated": "1567780450202", "due_date": null, "folder": { "id": "456" }, "id": "9hv", "linked_tasks": [], "list": { "id": "123" }, "name": "Task Name", "orderindex": "1.00000000000000000000000000000000", "parent": null, "priority": null, "space": { "id": "789" }, "start_date": null, "status": { "color": "#d3d3d3", "orderindex": 1, "status": "in progress", "type": "custom" }, "time_estimate": null, "time_spent": null, "url": "https://app.clickup.com/t/9hx" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Task Link", "summary": "Delete Task Link" }, "post": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "9hz", "in": "path", "name": "links_to", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "task": { "tags": [], "assignees": [], "checklists": [], "creator": { "color": "#827718", "id": 183, "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" }, "date_closed": null, "date_created": "1567780450202", "date_updated": "1567780450202", "due_date": null, "folder": { "id": "456" }, "id": "9hv", "linked_tasks": [ { "date_created": "1587571108988", "link_id": "9hz", "task_id": "9hv", "userid": "183" } ], "list": { "id": "123" }, "name": "Task Name", "orderindex": "1.00000000000000000000000000000000", "parent": null, "priority": null, "space": { "id": "789" }, "start_date": null, "status": { "color": "#d3d3d3", "orderindex": 1, "status": "in progress", "type": "custom" }, "time_estimate": null, "time_spent": null, "url": "https://app.clickup.com/t/9hx" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Add Task Link", "summary": "Add Task Link" } }, "/task/{task_id}/member": { "get": { "parameters": [ { "description": "", "example": "9hz", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "members": [ { "color": "#FFFFFF", "email": "john@example.com", "id": 812, "initials": "JD", "profileInfo": { "display_profile": null, "top_tier_user": null, "verified_ambassador": null, "verified_consultant": null, "viewed_top_tier_user": null, "viewed_verified_ambassador": null, "viewed_verified_consultant": null }, "profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg", "username": "John Doe" }, { "color": null, "email": "jane@example.com", "id": 813, "initials": "JD", "profileInfo": { "display_profile": null, "top_tier_user": null, "verified_ambassador": null, "verified_consultant": null, "viewed_top_tier_user": null, "viewed_verified_ambassador": null, "viewed_verified_consultant": null }, "profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg", "username": "Jane Doe" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Task Members", "summary": "Get Task Members" } }, "/task/{task_id}/tag/{tag_name}/": { "delete": { "parameters": [ { "description": "", "example": "abc", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "name", "in": "path", "name": "tag_name", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Remove Tag From Task", "summary": "Remove Tag From Task" }, "post": { "parameters": [ { "description": "", "example": "abc", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "name", "in": "path", "name": "tag_name", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Add Tag To Task", "summary": "Add Tag To Task" } }, "/task/{task_id}/time/": { "get": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "data": [ { "intervals": [ { "date_added": "1569983937761", "end": null, "id": "318", "source": "chrome", "start": null, "time": "1000000" } ], "time": 1000000, "user": { "color": "#795548", "email": "johndoe@gmail.com", "id": 1, "initials": "JD", "profilePicture": null, "username": "John Doe" } } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get tracked time", "summary": "Get tracked time" }, "post": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Track time", "requestBody": { "content": { "application/json": { "schema": { "example": { "end": 1508369194377, "start": 1567780450202, "time": 8640000 }, "properties": { "end": { "type": "number" }, "start": { "type": "number" }, "time": { "type": "number" } }, "type": "object" } } } }, "summary": "Track time" } }, "/task/{task_id}/time/{interval_id}/": { "delete": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "123", "in": "path", "name": "interval_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete time tracked", "summary": "Delete time tracked" }, "put": { "parameters": [ { "description": "", "example": "9hv", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "123", "in": "path", "name": "interval_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Edit time tracked", "requestBody": { "content": { "application/json": { "schema": { "example": { "end": 1508369194377, "start": 1567780450202, "time": 8640000 }, "properties": { "end": { "type": "number" }, "start": { "type": "number" }, "time": { "type": "number" } }, "type": "object" } } } }, "summary": "Edit time tracked" } }, "/task/{task_id}/time_in_status/": { "get": { "parameters": [ { "description": "", "example": "9hz", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "current_status": { "color": "#d3d3d3", "status": "open", "total_time": { "by_minute": 21708, "since": "1604004423494" } }, "status_history": [ { "color": "#d3d3d3", "orderindex": 0, "status": "open", "total_time": { "by_minute": 21707, "since": "1604004423494" }, "type": "open" }, { "color": "#5CF1D4", "orderindex": 4, "status": "active status", "total_time": { "by_minute": 23274, "since": "1602607941692" }, "type": "custom" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Task's Time in Status", "summary": "Get Task's Time in Status" } }, "/team": { "get": { "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Teams", "summary": "Get Teams" } }, "/team/{team_Id}/task": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_Id", "required": true, "schema": { "type": "number" } }, { "description": "Page to fetch", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "Order by field, defaults to created\n Options: id, created, updated, due_date\n", "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "description": "Reverse order", "in": "query", "name": "reverse", "required": false, "schema": { "type": "boolean" } }, { "description": "Include subtasks, default false", "in": "query", "name": "subtasks", "required": false, "schema": { "type": "boolean" } }, { "description": "Spaces to query", "in": "query", "name": "space_ids%5B%5D", "required": false, "schema": { "type": "array" } }, { "description": "Folders to query", "in": "query", "name": "project_ids%5B%5D", "required": false, "schema": { "type": "array" } }, { "description": "Lists to query", "in": "query", "name": "list_ids%5B%5D", "required": false, "schema": { "type": "array" } }, { "description": "Statuses to query", "in": "query", "name": "statuses%5B%5D", "required": false, "schema": { "type": "array" } }, { "description": "By default, this call does not include closed tasks. Set this to true and dont send a status filter to include closed tasks.", "in": "query", "name": "include_closed", "required": false, "schema": { "type": "boolean" } }, { "description": "Assignees to query", "in": "query", "name": "assignees%5B%5D", "required": false, "schema": { "type": "array" } }, { "description": "Tag names to query", "in": "query", "name": "tags%5B%5D", "required": false, "schema": { "type": "array" } }, { "description": "Filter due date greater than Unix time in milliseconds", "in": "query", "name": "due_date_gt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter due date less than Unix time in milliseconds", "in": "query", "name": "due_date_lt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter date created greater than Unix time in milliseconds", "in": "query", "name": "date_created_gt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter date created less than Unix time in milliseconds", "in": "query", "name": "date_created_lt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter date updated greater than Unix time in milliseconds", "in": "query", "name": "date_updated_gt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter date updated less than Unix time in milliseconds", "in": "query", "name": "date_updated_lt", "required": false, "schema": { "type": "integer" } }, { "description": "Filter by Custom Fields. Must be a stringified JSON array of objects that must include `field_id`, `operator`, and `value`.\n\n+ See the **Custom Fields** reference page for additional information on valid input for fields `value` and `field_id` for different types of Custom Fields. The example below includes a Number Custom Field and a Users Custom Field.\n\n+ Accepted Values for `operator`: `=`, `<`, `<=`, `>`, `>=`, `!=`, `IS NULL` ,`IS NOT NULL` ,`RANGE`, `ANY`, `ALL`, `NOT ANY`, `NOT ALL`\n\n+ Example: `?custom_fields=[{\"field_id\":\"de761538-8ae0-42e8-91d9-f1a0cdfbd8b5\",\"operator\":\">\",\"value\":2},{\"field_id\":\"bd12538-4cf0-51f3-13h1-a1c0bedae3f7\",\"operator\":\"ANY\",\"value\":[123456,765432]},{...}]`", "in": "query", "name": "custom_fields%5B%5D", "required": false, "schema": { "type": "string" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "tasks": [ { "tags": [ { "name": "tagged", "tag_bg": "#000000", "tag_fg": "#000000" } ], "assignees": [ { "color": "#000000", "email": "johndoe@website.com", "id": 123, "profilePicture": "https://clickup.com/avatar.jpg", "username": "John Doe" } ], "checklists": [ { "creator": 2770032, "date_created": "1618455803730", "id": "d41340bc-2f17-43cc-ae71-86628f45825f", "items": [ { "assignee": null, "children": [], "date_created": "1618455810454", "id": "9398cb3d-55a4-4c45-ab46-2a47a371e375", "name": "checklist item 1", "orderindex": 0, "parent": null, "resolved": false } ], "name": "Checklist", "orderindex": 1, "resolved": 0, "task_id": "3cxv9f", "unresolved": 1 } ], "creator": { "color": "#000000", "email": "johndoe@website.com", "id": 123, "profilePicture": "https://clickup.com/avatar.jpg", "username": "John Doe" }, "custom_fields": [ { "date_created": "1617765143523", "hide_from_guests": false, "id": "be43f58e-989e-4233-9f25-27584f094b74", "name": "Location type Custom Field", "required": false, "type": "location", "type_config": {} } ], "custom_id": null, "date_closed": "1508369194377", "date_created": "1508369194377", "date_updated": "1508369194377", "dependencies": [], "description": "Task description", "due_date": "1508369194377", "folder": { "access": true, "hidden": false, "id": "1", "name": "Folder" }, "id": "av1", "linked_tasks": [], "list": { "access": true, "id": "1", "name": "List" }, "name": "My First Task", "orderindex": "1.0000", "parent": "av2", "permission_level": "create", "points": 1.3, "priority": 1, "project": { "access": true, "hidden": false, "id": "1", "name": "Folder" }, "space": { "id": "1" }, "start_date": "1508369194377", "status": { "color": "#000000", "orderindex": 1, "status": "Open", "type": "open" }, "team_id": "1234", "text_content": "Task description", "time_estimate": 1.2, "url": "https://app.clickup.com/t/av1", "watchers": [ { "color": "#000000", "email": "johndoe@website.com", "id": 123, "profilePicture": "https://clickup.com/avatar.jpg", "username": "John Doe" } ] } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Filtered Team Tasks", "summary": "Get Filtered Team Tasks" } }, "/team/{team_Id}/time_entries": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_Id", "required": true, "schema": { "type": "number" } }, { "description": "Unix time in milliseconds", "in": "query", "name": "start_date", "required": false, "schema": { "type": "number" } }, { "description": "Unix time in milliseconds", "in": "query", "name": "end_date", "required": false, "schema": { "type": "number" } }, { "description": "User ids to filter by separated by commas.\n\n+ ***Note:** Only Workspace Owners/Admins have access to do this.*", "in": "query", "name": "assignee", "required": false, "schema": { "type": "number" } }, { "description": "Include task tags in the response for time entries associated with tasks.", "in": "query", "name": "include_task_tags", "required": false, "schema": { "type": "boolean" } }, { "description": "Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`.", "in": "query", "name": "include_location_names", "required": false, "schema": { "type": "boolean" } }, { "description": "Only include time entries associated with tasks in a specific Space", "in": "query", "name": "space_id", "required": false, "schema": { "type": "number" } }, { "description": "Only include time entries associated with tasks in a specific Folder", "in": "query", "name": "folder_id", "required": false, "schema": { "type": "number" } }, { "description": "Only include time entries associated with tasks in a specific List", "in": "query", "name": "list_id", "required": false, "schema": { "type": "number" } }, { "description": "Only include time entries associated with a specific task", "in": "query", "name": "task_id", "required": false, "schema": { "type": "number" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "data": [ { "tags": [], "at": "1592845899021", "billable": false, "description": "", "duration": "4339892", "end": "1592845899021", "id": "1963465985517105840", "source": "clickup", "start": "1592841559129", "task": { "custom_id": "JOSH-917", "custom_type": null, "id": "1vwwavv", "name": "woof", "status": { "color": "#d3d3d3", "orderindex": 0, "status": "open yes", "type": "open" } }, "task_location": { "folder_id": 468300080, "folder_name": "Folder", "list_id": 1560300071, "list_name": "List", "space_id": 22800253, "space_name": "Space" }, "task_tags": [ { "creator": 301828, "name": "content-request", "tag_bg": "#2ecd6f", "tag_fg": "#800000" }, { "creator": 301828, "name": "marketing-okr", "tag_bg": "#7C4DFF", "tag_fg": "#800000" } ], "task_url": "https://staging.clickup.com/t/1vwwavv", "user": { "color": "#08c7e0", "email": "test@gmail.com", "id": 1, "initials": "JK", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/1_HHk.jpg", "username": "first_name last_name" }, "wid": "300702" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get time entries within a date range", "summary": "Get time entries within a date range" } }, "/team/{team_Id}/time_entries/": { "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_Id", "required": true, "schema": { "type": "number" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "tags": [ { "name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#BF55EC" } ], "assignee": 1, "billable": true, "description": "from api", "duration": 50000, "start": 1595282645000, "tid": "task_id" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create a time entry", "requestBody": { "content": { "application/json": { "schema": { "example": { "tags": [ { "name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF" } ], "assignee": 1, "billable": true, "description": "from api", "duration": 50000, "start": 1595282645000, "tid": "task_id" }, "properties": { "tags": { "items": { "properties": { "name": { "type": "string" }, "tag_bg": { "type": "string" }, "tag_fg": { "type": "string" } }, "type": "object" }, "type": "array" }, "assignee": { "type": "number" }, "billable": { "type": "boolean" }, "description": { "type": "string" }, "duration": { "type": "number" }, "start": { "type": "number" }, "tid": { "type": "string" } }, "type": "object" } } } }, "summary": "Create a time entry" } }, "/team/{team_Id}/time_entries/start/{timer_id}/": { "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_Id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "2004673344540003570", "in": "path", "name": "timer_id", "required": true, "schema": { "type": "number" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "data": { "tags": [], "at": 1595289452790, "billable": false, "description": "", "duration": -53, "id": "timer_id", "start": "1595289395842", "task": { "custom_type": null, "id": "task_id", "name": "test task", "status": { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" } }, "user": { "color": "#08c7e0", "email": "test@gmail.com", "id": 1, "initials": "JK", "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg", "username": "first_name last_name" }, "wid": "workspace_id" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Start a time Entry", "summary": "Start a time Entry" } }, "/team/{team_Id}/time_entries/{timer_id}/": { "put": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_Id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "2004673344540003570", "in": "path", "name": "timer_id", "required": true, "schema": { "type": "number" } }, { "description": "If you want to reference a task by it's custom task id, this value must be `true`", "in": "query", "name": "custom_task_ids", "required": false, "schema": { "type": "string" } }, { "description": "Only used when the parameter is set to `custom_task_ids=true`\n\n+ Example: `custom_task_ids=true&team_id=123`", "in": "query", "name": "team_id", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update a time Entry", "requestBody": { "content": { "application/json": { "schema": { "example": { "tags": [ { "name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF" } ], "billable": true, "description": "", "duration": 100000, "end": 1595289495842, "start": 1595289395842, "tag_action": "add", "tid": "task_id" }, "properties": { "tags": { "items": { "properties": { "name": { "type": "string" }, "tag_bg": { "type": "string" }, "tag_fg": { "type": "string" } }, "type": "object" }, "type": "array" }, "billable": { "type": "boolean" }, "description": { "type": "string" }, "duration": { "type": "number" }, "end": { "type": "number" }, "start": { "type": "number" }, "tag_action": { "type": "string" }, "tid": { "type": "string" } }, "type": "object" } } } }, "summary": "Update a time Entry" } }, "/team/{team_id}/goal": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "true", "in": "query", "name": "include_completed", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "folders": [ { "creator": 182, "date_created": "1548802674671", "goal_count": 0, "goals": [], "id": "05921253-7737-44af-a1aa-36fd11244e6f", "members": [ { "color": "#827718", "email": "janedoe@gmail.com", "id": 182, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg", "username": "Jane Doe" } ], "name": "Goal Folder", "private": true, "team_id": "512" } ], "goals": [ { "archived": false, "color": "#32a852", "creator": 183, "date_created": "1568044355026", "description": "Updated Goal Description", "due_date": "1568036964079", "folder_id": null, "history": [], "id": "e53a033c-900e-462d-a849-4a216b06d930", "key_results": [], "members": [], "multiple_owners": true, "name": "Updated Goal Name", "owners": [ { "color": "#827718", "email": "janedoe@gmail.com", "id": 182, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg", "username": "Jane Doe" } ], "percent_completed": 0, "pretty_id": "6", "pretty_url": "https://app.clickup.com/512/goals/6", "private": false, "start_date": null, "team_id": "512" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Goals", "summary": "Get Goals" }, "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "goal": { "archived": false, "color": "#32a852", "creator": 183, "date_created": "1568044355026", "description": "Goal Description", "due_date": "1568036964079", "folder_id": null, "history": [], "id": "e53a033c-900e-462d-a849-4a216b06d930", "key_results": [], "members": [], "multiple_owners": true, "name": "Goal Name", "owners": [ { "color": "#827718", "email": "johndoe@gmail.com", "id": 183, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" } ], "percent_completed": 0, "pretty_id": "6", "pretty_url": "https://app.clickup.com/512/goals/6", "private": false, "start_date": null, "team_id": "512" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Goal", "requestBody": { "content": { "application/json": { "schema": { "example": { "color": "#32a852", "description": "Goal Description", "due_date": 1568036964079, "multiple_owners": true, "name": "Goal Name", "owners": [ 183 ] }, "properties": { "color": { "type": "string" }, "description": { "type": "string" }, "due_date": { "type": "number" }, "multiple_owners": { "type": "boolean" }, "name": { "type": "string" }, "owners": { "items": { "type": "number" }, "type": "array" } }, "type": "object" } } } }, "summary": "Create Goal" } }, "/team/{team_id}/group": { "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "avatar": { "attachment_id": null, "color": null, "icon": null, "source": null }, "date_created": "1640122639829", "handle": "usergroup", "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", "initials": "U", "members": [ { "color": "#4169E1", "email": "sam@example.com", "id": 185, "initials": "S", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Sam" }, { "color": "#4169E1", "email": "alex@example.com", "id": 186, "initials": "A", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Alex" } ], "name": "User group", "team_id": "301540", "userid": 301828 } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Team", "summary": "Create Team" } }, "/team/{team_id}/guest": { "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Invite Guest To Workspace", "requestBody": { "content": { "application/json": { "schema": { "example": { "can_edit_tags": true, "can_see_time_estimated": true, "can_see_time_spent": true, "email": "guest@example.com" }, "properties": { "can_edit_tags": { "type": "boolean" }, "can_see_time_estimated": { "type": "boolean" }, "can_see_time_spent": { "type": "boolean" }, "email": { "type": "string" } }, "type": "object" } } } }, "summary": "Invite Guest To Workspace" } }, "/team/{team_id}/guest/{guest_id}": { "delete": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "guest_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Remove Guest From Workspace", "summary": "Remove Guest From Workspace" }, "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "guest_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Guest", "summary": "Get Guest" }, "put": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "guest_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "guest": { "can_edit_tags": true, "can_see_time_estimated": true, "can_see_time_spent": true, "invited_by": { "color": "#827718", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "shared": { "folders": [], "lists": [], "tasks": [] }, "user": { "color": null, "date_invited": "1583358383412", "date_joined": null, "email": "guest@example.com", "id": 184, "initials": "G", "last_active": null, "profilePicture": null, "role": 4, "username": null } } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Edit Guest On Workspace", "requestBody": { "content": { "application/json": { "schema": { "example": { "can_edit_tags": true, "can_see_time_estimated": true, "can_see_time_spent": true, "username": "Guest User" }, "properties": { "can_edit_tags": { "type": "boolean" }, "can_see_time_estimated": { "type": "boolean" }, "can_see_time_spent": { "type": "boolean" }, "username": { "type": "string" } }, "type": "object" } } } }, "summary": "Edit Guest On Workspace" } }, "/team/{team_id}/shared": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "shared": { "folders": [ { "archived": false, "content": null, "due_date": null, "id": "1058", "name": "Shared Folder", "orderindex": 0, "task_count": "0" } ], "lists": [ { "archived": false, "assignee": null, "content": null, "due_date": null, "id": "1421", "name": "Shared List", "orderindex": 0, "priority": null, "start_date": null, "status": null, "task_count": "0" } ], "tasks": [] } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Shared Hierarchy", "summary": "Shared Hierarchy" } }, "/team/{team_id}/space": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "false", "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "spaces": [ { "features": { "tags": { "enabled": false }, "checklists": { "enabled": true }, "custom_fields": { "enabled": true }, "dependency_warning": { "enabled": false }, "due_dates": { "enabled": false, "remap_closed_due_date": false, "remap_due_dates": false, "start_date": false }, "portfolios": { "enabled": false }, "remap_dependencies": { "enabled": false }, "time_estimates": { "enabled": false }, "time_tracking": { "enabled": false } }, "id": "790", "multiple_assignees": false, "name": "Updated Space Name", "private": false, "statuses": [ { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" }, { "color": "#6bc950", "orderindex": 1, "status": "complete", "type": "closed" } ] }, { "features": { "tags": { "enabled": true }, "checklists": { "enabled": true }, "due_dates": { "enabled": true, "remap_closed_due_date": false, "remap_due_dates": false, "start_date": false }, "time_estimates": { "enabled": true }, "time_tracking": { "enabled": true } }, "id": "791", "multiple_assignees": true, "name": "Second Space Name", "private": false, "statuses": [ { "color": "#d3d3d3", "orderindex": 0, "status": "Open", "type": "open" }, { "color": "#6bc950", "orderindex": 1, "status": "Closed", "type": "closed" } ] } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Spaces", "summary": "Get Spaces" }, "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "archived": false, "features": { "tags": { "enabled": true }, "checklists": { "enabled": true }, "custom_fields": { "enabled": true }, "custom_items": { "enabled": false }, "dependency_warning": { "enabled": true }, "due_dates": { "enabled": true, "remap_closed_due_date": false, "remap_due_dates": true, "start_date": false }, "emails": { "enabled": true }, "milestones": { "enabled": false }, "multiple_assignees": { "enabled": true }, "points": { "enabled": false }, "portfolios": { "enabled": true }, "remap_dependencies": { "enabled": true }, "sprints": { "enabled": false }, "time_estimates": { "enabled": true }, "zoom": { "enabled": false } }, "id": "790", "multiple_assignees": true, "name": "New Space Name", "private": false, "statuses": [ { "color": "#d3d3d3", "id": "p16911531_p8y2WNC6", "orderindex": 0, "status": "to do", "type": "open" }, { "color": "#6bc950", "id": "p17911545_ABo7jSsf", "orderindex": 1, "status": "complete", "type": "closed" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Space", "requestBody": { "content": { "application/json": { "schema": { "example": { "features": { "tags": { "enabled": true }, "checklists": { "enabled": true }, "custom_fields": { "enabled": true }, "dependency_warning": { "enabled": true }, "due_dates": { "enabled": true, "remap_closed_due_date": false, "remap_due_dates": true, "start_date": false }, "portfolios": { "enabled": true }, "remap_dependencies": { "enabled": true }, "time_estimates": { "enabled": true }, "time_tracking": { "enabled": false } }, "multiple_assignees": true, "name": "New Space Name" }, "properties": { "features": { "properties": { "tags": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "checklists": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "custom_fields": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "dependency_warning": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "due_dates": { "properties": { "enabled": { "type": "boolean" }, "remap_closed_due_date": { "type": "boolean" }, "remap_due_dates": { "type": "boolean" }, "start_date": { "type": "boolean" } }, "type": "object" }, "portfolios": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "remap_dependencies": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "time_estimates": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "time_tracking": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "multiple_assignees": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Space" } }, "/team/{team_id}/taskTemplate": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "0", "in": "query", "name": "page", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "templates": [] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Task Templates", "summary": "Get Task Templates" } }, "/team/{team_id}/time_entries/current": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "user id", "in": "query", "name": "assignee", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "data": { "tags": [], "at": "1595293042560", "billable": false, "description": "", "duration": -25655, "id": "timer_id", "start": "1595293042560", "task": { "id": "task_id", "name": "task_name", "status": { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" } }, "user": { "color": "#08c7e0", "email": "test@gmail.com", "id": 300528, "initials": "JK", "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg", "username": "first_name last_name" }, "wid": "workspace_id" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get running time entry", "summary": "Get running time entry" } }, "/team/{team_id}/time_entries/stop": { "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "data": { "tags": [], "at": 1595289452790, "billable": false, "description": "", "duration": 56948, "end": 1595289452790, "id": "timer_id", "source": "clickup", "start": "1595289395842", "task": { "custom_type": null, "id": "task_id", "name": "test task", "status": { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" } }, "user": { "color": "#08c7e0", "email": "test@gmail.com", "id": 1, "initials": "JK", "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg", "username": "first_name last_name" }, "wid": "workspace_id" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Stop a time Entry", "summary": "Stop a time Entry" } }, "/team/{team_id}/time_entries/tags": { "delete": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Remove tags from time entries", "requestBody": { "content": { "application/json": { "schema": { "example": { "tags": [ { "name": "name of tag" } ], "time_entry_ids": [ "timer_id" ] }, "properties": { "tags": { "items": { "properties": { "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "time_entry_ids": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "summary": "Remove tags from time entries" }, "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "data": [ { "creator": 1, "name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get all tags from time entries", "summary": "Get all tags from time entries" }, "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Add tags from time entries", "requestBody": { "content": { "application/json": { "schema": { "example": { "tags": [ { "name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF" } ], "time_entry_ids": [ "timer_id" ] }, "properties": { "tags": { "items": { "properties": { "name": { "type": "string" }, "tag_bg": { "type": "string" }, "tag_fg": { "type": "string" } }, "type": "object" }, "type": "array" }, "time_entry_ids": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "summary": "Add tags from time entries" }, "put": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Change tag names from time entries", "requestBody": { "content": { "application/json": { "schema": { "example": { "name": "old tag name", "new_name": "new tag name", "tag_bg": "#000000", "tag_fg": "#000000" }, "properties": { "name": { "type": "string" }, "new_name": { "type": "string" }, "tag_bg": { "type": "string" }, "tag_fg": { "type": "string" } }, "type": "object" } } } }, "summary": "Change tag names from time entries" } }, "/team/{team_id}/time_entries/{timer_id}": { "delete": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "List of timer ids to delete separated by commas", "in": "path", "name": "timer_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "data": { "tags": [], "at": 1595289452790, "billable": false, "description": "", "duration": 56948, "end": 1595289452790, "id": "timer_id", "source": "clickup", "start": "1595289395842", "task": { "custom_type": null, "id": "task_id", "name": "test task", "status": { "color": "#d3d3d3", "orderindex": 0, "status": "to do", "type": "open" } }, "user": { "color": "#08c7e0", "email": "test@gmail.com", "id": 1, "initials": "JK", "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg", "username": "first_name last_name" }, "wid": "workspace_id" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete a time Entry", "summary": "Delete a time Entry" } }, "/team/{team_id}/time_entries/{timer_id}/": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "1963465985517105840", "in": "path", "name": "timer_id", "required": true, "schema": { "type": "string" } }, { "description": "Include task tags in the response for time entries associated with tasks.", "in": "query", "name": "include_task_tags", "required": false, "schema": { "type": "boolean" } }, { "description": "Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`.", "in": "query", "name": "include_location_names", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "data": [ { "tags": [], "at": "1592845899021", "billable": false, "description": "", "duration": "4339892", "end": "1592845899021", "id": "timer_id", "source": "clickup", "start": "1592841559129", "task_location": { "folder_id": 468300080, "folder_name": "Folder", "list_id": 1560300071, "list_name": "List", "space_id": 22800253, "space_name": "Space" }, "task_tags": [ { "creator": 301828, "name": "content-request", "tag_bg": "#2ecd6f", "tag_fg": "#800000" }, { "creator": 301828, "name": "marketing-okr", "tag_bg": "#7C4DFF", "tag_fg": "#800000" } ], "task_url": "https://staging.clickup.com/t/rnmuwz7", "user": { "color": "#08c7e0", "email": "test@gmail.com", "id": 1, "initials": "JK", "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg", "username": "first_name last_name" }, "wid": "workspace_id" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get singular time entry", "summary": "Get singular time entry" } }, "/team/{team_id}/time_entries/{timer_id}/history": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "1963465985517105840", "in": "path", "name": "timer_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get time entry history", "summary": "Get time entry history" } }, "/team/{team_id}/user": { "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Invite User To Workspace", "requestBody": { "content": { "application/json": { "schema": { "example": { "admin": true, "email": "user@example.com" }, "properties": { "admin": { "type": "boolean" }, "email": { "type": "string" } }, "type": "object" } } } }, "summary": "Invite User To Workspace" } }, "/team/{team_id}/user/{user_id}": { "delete": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "user_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Remove User From Workspace", "summary": "Remove User From Workspace" }, "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "user_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get User", "summary": "Get User" }, "put": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } }, { "description": "", "example": "403", "in": "path", "name": "user_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "member": { "invited_by": { "color": "#827718", "email": "jerry@example.com", "id": 183, "initials": "J", "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg", "username": "Jerry" }, "shared": { "folders": [], "lists": [], "tasks": [] }, "user": { "color": null, "date_invited": "1583358383412", "date_joined": null, "email": "user@example.com", "id": 184, "initials": "G", "last_active": null, "profilePicture": null, "role": 3, "username": "User Name" } } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Edit User On Workspace", "requestBody": { "content": { "application/json": { "schema": { "example": { "admin": false, "username": "User Name" }, "properties": { "admin": { "type": "boolean" }, "username": { "type": "string" } }, "type": "object" } } } }, "summary": "Edit User On Workspace" } }, "/team/{team_id}/view": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "views": [ { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-105", "name": "New View Name", "parent": { "id": "512", "type": 7 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Team Views", "summary": "Get Team Views" }, "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "view": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-105", "name": "New Team View Name", "parent": { "id": "512", "type": 7 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Team View", "requestBody": { "content": { "application/json": { "schema": { "example": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "name": "New Team View Name", "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" }, "properties": { "columns": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "divide": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "nullable": true }, "field": { "nullable": true } }, "type": "object" }, "filters": { "properties": { "fields": { "items": {}, "type": "array" }, "op": { "type": "string" }, "search": { "type": "string" }, "show_closed": { "type": "boolean" } }, "type": "object" }, "grouping": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "type": "number" }, "field": { "type": "string" }, "ignore": { "type": "boolean" } }, "type": "object" }, "name": { "type": "string" }, "settings": { "properties": { "collapse_empty_columns": { "nullable": true }, "me_checklists": { "type": "boolean" }, "me_comments": { "type": "boolean" }, "me_subtasks": { "type": "boolean" }, "show_assignees": { "type": "boolean" }, "show_closed_subtasks": { "type": "boolean" }, "show_images": { "type": "boolean" }, "show_subtask_parent_names": { "type": "boolean" }, "show_subtasks": { "type": "number" }, "show_task_locations": { "type": "boolean" } }, "type": "object" }, "sorting": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "team_sidebar": { "properties": { "assigned_comments": { "type": "boolean" }, "assignees": { "items": {}, "type": "array" }, "unassigned_tasks": { "type": "boolean" } }, "type": "object" }, "type": { "type": "string" } }, "type": "object" } } } }, "summary": "Create Team View" } }, "/team/{team_id}/webhook": { "get": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "webhooks": [ { "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", "endpoint": "https://yourdomain.com/webhook", "events": [ "taskCreated", "taskUpdated", "taskDeleted", "taskPriorityUpdated", "taskStatusUpdated", "taskAssigneeUpdated", "taskDueDateUpdated", "taskTagUpdated", "taskMoved", "taskCommentPosted", "taskCommentUpdated", "taskTimeEstimateUpdated", "taskTimeTrackedUpdated", "listCreated", "listUpdated", "listDeleted", "folderCreated", "folderUpdated", "folderDeleted", "spaceCreated", "spaceUpdated", "spaceDeleted", "goalCreated", "goalUpdated", "goalDeleted", "keyResultCreated", "keyResultUpdated", "keyResultDeleted" ], "folder_id": null, "health": { "fail_count": 5, "status": "failing" }, "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", "list_id": null, "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA", "space_id": null, "task_id": null, "team_id": 108, "userid": 183 } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Webhooks", "summary": "Get Webhooks" }, "post": { "parameters": [ { "description": "Team ID (Workspace)", "example": "123", "in": "path", "name": "team_id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", "webhook": { "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", "endpoint": "https://yourdomain.com/webhook", "events": [ "taskCreated", "taskUpdated", "taskDeleted", "taskPriorityUpdated", "taskStatusUpdated", "taskAssigneeUpdated", "taskDueDateUpdated", "taskTagUpdated", "taskMoved", "taskCommentPosted", "taskCommentUpdated", "taskTimeEstimateUpdated", "taskTimeTrackedUpdated", "listCreated", "listUpdated", "listDeleted", "folderCreated", "folderUpdated", "folderDeleted", "spaceCreated", "spaceUpdated", "spaceDeleted", "goalCreated", "goalUpdated", "goalDeleted", "keyResultCreated", "keyResultUpdated", "keyResultDeleted" ], "folder_id": null, "health": { "fail_count": 0, "status": "active" }, "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", "list_id": null, "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA", "space_id": null, "task_id": null, "team_id": 108, "userid": 183 } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Webhook", "requestBody": { "content": { "application/json": { "schema": { "example": { "endpoint": "https://yourdomain.com/webhook", "events": [ "taskCreated", "taskUpdated", "taskDeleted", "taskPriorityUpdated", "taskStatusUpdated", "taskAssigneeUpdated", "taskDueDateUpdated", "taskTagUpdated", "taskMoved", "taskCommentPosted", "taskCommentUpdated", "taskTimeEstimateUpdated", "taskTimeTrackedUpdated", "listCreated", "listUpdated", "listDeleted", "folderCreated", "folderUpdated", "folderDeleted", "spaceCreated", "spaceUpdated", "spaceDeleted", "goalCreated", "goalUpdated", "goalDeleted", "keyResultCreated", "keyResultUpdated", "keyResultDeleted" ] }, "properties": { "endpoint": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "summary": "Create Webhook" } }, "/user": { "get": { "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "user": { "color": "#000000", "id": 123, "profilePicture": "https://clickup.com/avatar.jpg", "username": "John Doe" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Authorized User", "summary": "Get Authorized User" } }, "/view/{view_id}": { "delete": { "parameters": [ { "description": "105 (string)", "example": "3c", "in": "path", "name": "view_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete View", "summary": "Delete View" }, "get": { "parameters": [ { "description": "105 (string)", "example": "3c", "in": "path", "name": "view_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "view": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-105", "name": "New View Name", "parent": { "id": "512", "type": 7 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get View", "summary": "Get View" }, "put": { "parameters": [ { "description": "105 (string)", "example": "3c", "in": "path", "name": "view_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "view": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "id": "3c-105", "name": "New View Name", "parent": { "id": "512", "type": 7 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update View", "requestBody": { "content": { "application/json": { "schema": { "example": { "columns": { "fields": [] }, "divide": { "collapsed": [], "dir": null, "field": null }, "filters": { "fields": [], "op": "AND", "search": "", "show_closed": false }, "grouping": { "collapsed": [], "dir": 1, "field": "status", "ignore": false }, "name": "New View Name", "parent": { "id": "512", "type": 7 }, "settings": { "collapse_empty_columns": null, "me_checklists": true, "me_comments": true, "me_subtasks": true, "show_assignees": true, "show_closed_subtasks": false, "show_images": true, "show_subtask_parent_names": false, "show_subtasks": 3, "show_task_locations": false }, "sorting": { "fields": [] }, "team_sidebar": { "assigned_comments": false, "assignees": [], "unassigned_tasks": false }, "type": "list" }, "properties": { "columns": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "divide": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "nullable": true }, "field": { "nullable": true } }, "type": "object" }, "filters": { "properties": { "fields": { "items": {}, "type": "array" }, "op": { "type": "string" }, "search": { "type": "string" }, "show_closed": { "type": "boolean" } }, "type": "object" }, "grouping": { "properties": { "collapsed": { "items": {}, "type": "array" }, "dir": { "type": "number" }, "field": { "type": "string" }, "ignore": { "type": "boolean" } }, "type": "object" }, "name": { "type": "string" }, "parent": { "properties": { "id": { "type": "string" }, "type": { "type": "number" } }, "type": "object" }, "settings": { "properties": { "collapse_empty_columns": { "nullable": true }, "me_checklists": { "type": "boolean" }, "me_comments": { "type": "boolean" }, "me_subtasks": { "type": "boolean" }, "show_assignees": { "type": "boolean" }, "show_closed_subtasks": { "type": "boolean" }, "show_images": { "type": "boolean" }, "show_subtask_parent_names": { "type": "boolean" }, "show_subtasks": { "type": "number" }, "show_task_locations": { "type": "boolean" } }, "type": "object" }, "sorting": { "properties": { "fields": { "items": {}, "type": "array" } }, "type": "object" }, "team_sidebar": { "properties": { "assigned_comments": { "type": "boolean" }, "assignees": { "items": {}, "type": "array" }, "unassigned_tasks": { "type": "boolean" } }, "type": "object" }, "type": { "type": "string" } }, "type": "object" } } } }, "summary": "Update View" } }, "/view/{view_id}/comment": { "post": { "parameters": [ { "description": "105 (string)", "example": "3c", "in": "path", "name": "view_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "date": 1568037065216, "hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae", "id": "459" } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Create Chat View Comment", "requestBody": { "content": { "application/json": { "schema": { "example": { "comment_text": "View comment content", "notify_all": true }, "properties": { "comment_text": { "type": "string" }, "notify_all": { "type": "boolean" } }, "type": "object" } } } }, "summary": "Create Chat View Comment" } }, "/view/{view_id}/comment/": { "get": { "parameters": [ { "description": "105 (string)", "example": "3c", "in": "path", "name": "view_id", "required": true, "schema": { "type": "string" } }, { "description": "Enter the `date` of a Chat view comment using Unix time in milliseconds", "in": "query", "name": "start", "required": false, "schema": { "type": "integer" } }, { "description": "Enter the Comment `id` of a Chat view comment", "in": "query", "name": "start_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "comments": [ { "assigned_by": null, "assignee": null, "comment": [ { "text": "View comment content" } ], "comment_text": "View comment content", "date": "1568036964079", "id": "459", "reactions": [], "resolved": false, "user": { "color": "#827718", "email": "johndoe@gmail.com", "id": 183, "initials": "JD", "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg", "username": "John Doe" } } ] } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get Chat View Comments", "summary": "Get Chat View Comments" } }, "/view/{view_id}/task": { "get": { "parameters": [ { "description": "105 (string)", "example": "3c", "in": "path", "name": "view_id", "required": true, "schema": { "type": "string" } }, { "description": "", "example": "0", "in": "query", "name": "page", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Get View Tasks", "summary": "Get View Tasks" } }, "/webhook/{webhook_id}": { "delete": { "parameters": [ { "description": "e506-4a29-9d42-26e504e3435e (uuid)", "example": "4b67ac88", "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": {} } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Delete Webhook", "summary": "Delete Webhook" }, "put": { "parameters": [ { "description": "e506-4a29-9d42-26e504e3435e (uuid)", "example": "4b67ac88", "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", "webhook": { "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", "endpoint": "https://yourdomain.com/webhook", "events": [ "taskCreated", "taskUpdated", "taskDeleted", "taskPriorityUpdated", "taskStatusUpdated", "taskAssigneeUpdated", "taskDueDateUpdated", "taskTagUpdated", "taskMoved", "taskCommentPosted", "taskCommentUpdated", "taskTimeEstimateUpdated", "taskTimeTrackedUpdated", "listCreated", "listUpdated", "listDeleted", "folderCreated", "folderUpdated", "folderDeleted", "spaceCreated", "spaceUpdated", "spaceDeleted", "goalCreated", "goalUpdated", "goalDeleted", "keyResultCreated", "keyResultUpdated", "keyResultDeleted" ], "folder_id": null, "health": { "fail_count": 0, "status": "active" }, "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", "list_id": null, "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA", "space_id": null, "task_id": null, "team_id": 108, "userid": 183 } } } } } }, "description": "OK", "headers": {} } }, "tags": [], "description": "", "operationId": "Update Webhook", "requestBody": { "content": { "application/json": { "schema": { "example": { "endpoint": "https://yourdomain.com/webhook", "events": "*", "status": "active" }, "properties": { "endpoint": { "type": "string" }, "events": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } } }, "summary": "Update Webhook" } } }, "components": { "requestBodies": { "Add_Guest_To_TaskBody": { "content": { "application/json": { "schema": { "example": { "permission_level": "read" }, "properties": { "permission_level": { "type": "string" } }, "type": "object" } } } }, "Create_ListBody": { "content": { "application/json": { "schema": { "example": { "assignee": 183, "content": "New List Content", "due_date": 1567780450202, "due_date_time": false, "name": "New List Name", "priority": 1, "status": "red" }, "properties": { "assignee": { "type": "number" }, "content": { "type": "string" }, "due_date": { "type": "number" }, "due_date_time": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "number" }, "status": { "type": "string" } }, "type": "object" } } } }, "Track_timeBody": { "content": { "application/json": { "schema": { "example": { "end": 1508369194377, "start": 1567780450202, "time": 8640000 }, "properties": { "end": { "type": "number" }, "start": { "type": "number" }, "time": { "type": "number" } }, "type": "object" } } } } }, "schemas": { "Attachments": {}, "Authorization": {}, "Checklists": {}, "Comments": {}, "Custom_Fields": {}, "Dependencies": {}, "Folders": {}, "Goals": {}, "Guests": {}, "Lists": {}, "Members": {}, "Shared_Hierarchy": {}, "Spaces": {}, "Tags": {}, "Task_Templates": {}, "Tasks": {}, "Teams_User_Groups": {}, "Teams_Workspaces": {}, "Time_Tracking_2.0": {}, "Time_Tracking_Legacy": {}, "Users": {}, "Views": {}, "Webhooks": {} } }, "tags": [] }