### Create Folder View Response Example Source: https://developer.clickup.com/reference/createfolderview An example of a successful response when creating a folder view. It includes the 'view' object, which contains the details of the newly created folder view, mirroring the structure defined in the request. ```json { "view": { "id": "3c-107", "name": "New Folder View Name", "type": "list", "parent": { "id": "457", "type": 5 }, "grouping": { "field": "status", "dir": 1, "collapsed": [], "ignore": false }, "divide": { "field": null, "dir": null, "collapsed": [] }, "sorting": { "fields": [] }, "filters": { "op": "AND", "fields": [], "search": "", "show_closed": false }, "columns": { "fields": [] }, "team_sidebar": { "assignees": [], "assigned_comments": false, "unassigned_tasks": false }, "settings": { "show_task_locations": false, "show_subtasks": 3, "show_subtask_parent_names": false, "show_closed_subtasks": false, "show_assignees": true, "show_images": true, "collapse_empty_columns": null, "me_comments": true, "me_subtasks": true, "me_checklists": true } } } ``` -------------------------------- ### Task Object Example Source: https://developer.clickup.com/reference/addguesttotask This snippet shows an example of a task object returned by the ClickUp API, including details like status, creator, and associated list/folder/space. ```APIDOC ## Task Object Example ### Description This section provides a detailed example of a task object, illustrating its structure and the type of information it contains. ### Request Body ```json { "id": "c04", "name": "Task Name", "status": { "status": "Open", "color": "#d3d3d3", "type": "open", "orderindex": 0 }, "orderindex": "0", "date_created": "1574718405408", "date_updated": "1574722145869", "date_closed": null, "archived": false, "creator": { "id": 183, "username": "Jerry", "color": "#827718", "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" }, "assignees": [], "checklists": [], "tags": [], "parent": null, "priority": { "id": "1", "priority": "urgent", "color": "#f50000", "orderindex": "1" }, "due_date": "1508369194377", "start_date": null, "points": null, "time_estimate": null, "custom_fields": [], "dependencies": [], "team_id": "108", "url": "https://app.clickup.com/t/c04", "permission_level": "read", "list": { "id": "1752", "name": "Shared with me", "access": false }, "folder": { "id": "1217", "name": "Shared with me", "hidden": false, "access": false }, "space": { "id": "380" } } ``` ### Response Example ```json { "task": { "id": "c04", "name": "Task Name", "status": { "status": "Open", "color": "#d3d3d3", "type": "open", "orderindex": 0 }, "orderindex": "0", "date_created": "1574718405408", "date_updated": "1574722145869", "date_closed": null, "archived": false, "creator": { "id": 183, "username": "Jerry", "color": "#827718", "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" }, "assignees": [], "checklists": [], "tags": [], "parent": null, "priority": { "id": "1", "priority": "urgent", "color": "#f50000", "orderindex": "1" }, "due_date": "1508369194377", "start_date": null, "points": null, "time_estimate": null, "custom_fields": [], "dependencies": [], "team_id": "108", "url": "https://app.clickup.com/t/c04", "permission_level": "read", "list": { "id": "1752", "name": "Shared with me", "access": false }, "folder": { "id": "1217", "name": "Shared with me", "hidden": false, "access": false }, "space": { "id": "380" } } } ``` ``` -------------------------------- ### Example Folder View Object Source: https://developer.clickup.com/reference/createfolderview An example of a complete folder view object, demonstrating the structure for defining a list view with specific grouping, sorting, filtering, and column configurations. This object is used when creating or updating folder views via the API. ```json { "example": { "name": "New Folder View Name", "type": "list", "grouping": { "field": "status", "dir": 1, "collapsed": [], "ignore": false }, "divide": { "field": null, "dir": null, "collapsed": [] }, "sorting": { "fields": [ { "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", "dir": -1, "idx": 0 } ] }, "filters": { "op": "AND", "fields": [ { "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", "op": "EQ", "determinor": null, "idx": 0, "values": "123" } ], "search": "", "show_closed": false }, "columns": { "fields": [ { "field": "assignee", "idx": 0, "width": 160, "hidden": true, "name": null, "display": null } ] }, "team_sidebar": { "assignees": [], "assigned_comments": false, "unassigned_tasks": false }, "settings": { "show_task_locations": false, "show_subtasks": 3, "show_subtask_parent_names": false, "show_closed_subtasks": false, "show_assignees": true, "show_images": true, "collapse_empty_columns": null, "me_comments": true, "me_subtasks": true, "me_checklists": true } } } ``` -------------------------------- ### Task Object Example Source: https://developer.clickup.com/reference/addguesttotask This snippet shows an example of a task object returned by the ClickUp API, including details about its properties, assignees, and associated metadata. ```APIDOC ## Task Object Example ### Description This is an example of a task object, detailing its properties such as ID, name, status, creator, and associated metadata like priority and due dates. ### Method N/A (Example Data) ### Endpoint N/A (Example Data) ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) - **id** (string) - The unique identifier for the task. - **name** (string) - The name or title of the task. - **status** (object) - Information about the task's current status. - **creator** (object) - Details of the user who created the task. - **assignees** (array) - A list of users assigned to the task. - **checklists** (array) - A list of checklists associated with the task. - **tags** (array) - A list of tags applied to the task. - **priority** (object) - Information about the task's priority level. - **due_date** (string) - The due date of the task, in Unix timestamp format. - **url** (string) - A direct URL to the task in the ClickUp application. #### Response Example ```json { "id": "c04", "name": "Task Name", "status": { "status": "Open", "color": "#d3d3d3", "type": "open", "orderindex": 0 }, "orderindex": "0", "date_created": "1574718405408", "date_updated": "1574722145869", "date_closed": null, "archived": false, "creator": { "id": 183, "username": "Jerry", "color": "#827718", "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" }, "assignees": [], "checklists": [], "tags": [], "parent": null, "priority": { "id": "1", "priority": "urgent", "color": "#f50000", "orderindex": "1" }, "due_date": "1508369194377", "start_date": null, "points": null, "time_estimate": null, "custom_fields": [], "dependencies": [], "team_id": "108", "url": "https://app.clickup.com/t/c04", "permission_level": "read", "list": { "id": "1752", "name": "Shared with me", "access": false }, "folder": { "id": "1217", "name": "Shared with me", "hidden": false, "access": false }, "space": { "id": "380" } } ``` ``` -------------------------------- ### Example Space Object (JSON) Source: https://developer.clickup.com/reference/createspace This JSON object represents an example of a ClickUp space configuration. It includes details such as the space ID, name, privacy settings, status definitions, and the enablement of various features like multiple assignees and custom fields. This structure is useful for understanding the full scope of a space's settings. ```json { "id": "790", "name": "New Space Name", "private": false, "statuses": [ { "id": "p16911531_p8y2WNC6", "status": "to do", "type": "open", "orderindex": 0, "color": "#d3d3d3" }, { "id": "p17911545_ABo7jSsf", "status": "complete", "type": "closed", "orderindex": 1, "color": "#6bc950" } ], "multiple_assignees": true, "features": { "due_dates": { "enabled": true, "start_date": false, "remap_due_dates": true, "remap_closed_due_date": false }, "sprints": { "enabled": false }, "points": { "enabled": false }, "custom_items": { "enabled": false }, "tags": { "enabled": true }, "time_estimates": { "enabled": true }, "checklists": { "enabled": true }, "zoom": { "enabled": false }, "milestones": { "enabled": false }, "custom_fields": { "enabled": true }, "remap_dependencies": { "enabled": true }, "dependency_warning": { "enabled": true }, "multiple_assignees": { "enabled": true }, "portfolios": { "enabled": true }, "emails": { "enabled": true } }, "archived": false } ``` -------------------------------- ### Configure Due Dates Feature Source: https://developer.clickup.com/reference/createspace This example illustrates how to configure the 'due_dates' feature, including enabling it, and setting options for 'start_date', 'remap_due_dates', and 'remap_closed_due_date'. ```json { "due_dates": { "enabled": true, "start_date": false, "remap_due_dates": true, "remap_closed_due_date": false } } ``` -------------------------------- ### Guest User Object Example Source: https://developer.clickup.com/reference/addguesttotask This snippet illustrates the structure of a guest user object, including details about the user, who invited them, and their permissions. ```APIDOC ## Guest User Object Example ### Description This section details the structure of a guest user object, which includes information about the guest user, the inviter, and their specific permissions within a shared context. ### Request Body ```json { "guest": { "user": { "id": 184, "username": null, "email": "guest@example.com", "color": null, "profilePicture": null, "initials": "G", "role": 4, "last_active": null, "date_joined": null, "date_invited": "1583358383412" }, "invited_by": { "id": 183, "color": "#827718", "username": "Jerry", "email": "jerry@example.com", "initials": "J", "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" }, "can_see_time_spent": true, "can_see_time_estimated": true, "can_edit_tags": true } } ``` ### Response Example ```json { "guest": { "user": { "id": 184, "username": null, "email": "guest@example.com", "color": null, "profilePicture": null, "initials": "G", "role": 4, "last_active": null, "date_joined": null, "date_invited": "1583358383412" }, "invited_by": { "id": 183, "color": "#827718", "username": "Jerry", "email": "jerry@example.com", "initials": "J", "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" }, "can_see_time_spent": true, "can_see_time_estimated": true, "can_edit_tags": true } } ``` ``` -------------------------------- ### Guest User Example Source: https://developer.clickup.com/reference/addguesttotask This snippet illustrates the structure of a guest user object, including details about the user, who invited them, and their permissions within a shared context. ```APIDOC ## Guest User Object Example ### Description This example shows the structure of a guest user object, including the guest's details, information about the user who invited them, and their specific permissions for shared items. ### Method N/A (Example Data) ### Endpoint N/A (Example Data) ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) - **user** (object) - Details of the guest user. - **invited_by** (object) - Information about the user who sent the invitation. - **can_see_time_spent** (boolean) - Indicates if the guest can view time spent. - **can_see_time_estimated** (boolean) - Indicates if the guest can view estimated time. - **can_edit_tags** (boolean) - Indicates if the guest has permission to edit tags. - **shared** (object) - Details about the items shared with the guest. #### Response Example ```json { "guest": { "user": { "id": 184, "username": null, "email": "guest@example.com", "color": null, "profilePicture": null, "initials": "G", "role": 4, "last_active": null, "date_joined": null, "date_invited": "1583358383412" }, "invited_by": { "id": 183, "color": "#827718", "username": "Jerry", "email": "jerry@example.com", "initials": "J", "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" }, "can_see_time_spent": true, "can_see_time_estimated": true, "can_edit_tags": true, "shared": { "tasks": [ { "id": "c04", "name": "Task Name", "status": { "status": "Open", "color": "#d3d3d3", "type": "open", "orderindex": 0 }, "orderindex": "0", "date_created": "1574718405408", "date_updated": "1574722145869", "date_closed": null, "archived": false, "creator": { "id": 183, "username": "Jerry", "color": "#827718", "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" }, "assignees": [], "checklists": [], "tags": [], "parent": null, "priority": { "id": "1", "priority": "urgent", "color": "#f50000", "orderindex": "1" }, "due_date": "1508369194377", "start_date": null, "points": null, "time_estimate": null, "custom_fields": [], "dependencies": [], "team_id": "108", "url": "https://app.clickup.com/t/c04", "permission_level": "read", "list": { "id": "1752", "name": "Shared with me", "access": false }, "folder": { "id": "1217", "name": "Shared with me", "hidden": false, "access": false }, "space": { "id": "380" } } ], "lists": [], "folders": [] } } } ``` ``` -------------------------------- ### Guest User Example Source: https://developer.clickup.com/reference/addguesttolist This snippet demonstrates the structure of a guest user object within the ClickUp API, including user details, invited by information, and shared list permissions. ```APIDOC ## Guest User Object Example ### Description This example shows the structure of a guest user object, detailing their user information, who invited them, and the lists they have access to. ### Request Body ```json { "guest": { "user": { "id": 184, "username": null, "email": "guest@example.com", "color": null, "profilePicture": null, "initials": "G", "role": 4, "last_active": null, "date_joined": null, "date_invited": "1583358383412" }, "invited_by": { "id": 183, "color": "#827718", "username": "Jerry", "email": "jerry@example.com", "initials": "J", "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" }, "can_see_time_spent": true, "can_see_time_estimated": true, "can_edit_tags": true, "shared": { "tasks": [], "lists": [ { "id": "1427", "name": "List Name", "orderindex": 1, "status": null, "priority": null, "assignee": null, "task_count": "5", "due_date": null, "start_date": null, "archived": false, "override_statuses": true, "statuses": [ { "status": "Open", "orderindex": 0, "color": "#d3d3d3", "type": "open" }, { "status": "Closed", "orderindex": 5, "color": "#6bc950", "type": "closed" } ], "permission_level": "read" } ], "folders": [] } } } ``` ### Response Example ```json { "guest": { "user": { "id": 184, "username": null, "email": "guest@example.com", "color": null, "profilePicture": null, "initials": "G", "role": 4, "last_active": null, "date_joined": null, "date_invited": "1583358383412" }, "invited_by": { "id": 183, "color": "#827718", "username": "Jerry", "email": "jerry@example.com", "initials": "J", "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" }, "can_see_time_spent": true, "can_see_time_estimated": true, "can_edit_tags": true, "shared": { "tasks": [], "lists": [ { "id": "1427", "name": "List Name", "orderindex": 1, "status": null, "priority": null, "assignee": null, "task_count": "5", "due_date": null, "start_date": null, "archived": false, "override_statuses": true, "statuses": [ { "status": "Open", "orderindex": 0, "color": "#d3d3d3", "type": "open" }, { "status": "Closed", "orderindex": 5, "color": "#6bc950", "type": "closed" } ], "permission_level": "read" } ], "folders": [] } } } ``` ``` -------------------------------- ### GET /space Source: https://developer.clickup.com/reference/createspace Retrieves the configuration details for a specific ClickUp Space, including enabled features and status workflows. ```APIDOC ## GET /space ### Description Retrieves the details of a specific Space, including its name, privacy settings, status workflow, and enabled features. ### Method GET ### Endpoint /space/{space_id} ### Parameters #### Path Parameters - **space_id** (string) - Required - The unique identifier of the space. ### Request Example GET /space/790 ### Response #### Success Response (200) - **id** (string) - The space ID. - **name** (string) - The name of the space. - **private** (boolean) - Whether the space is private. - **statuses** (array) - List of status objects. - **features** (object) - Configuration for enabled features like tags, time estimates, and custom fields. #### Response Example { "id": "790", "name": "New Space Name", "private": false, "statuses": [ { "id": "p16911531_p8y2WNC6", "status": "to do", "type": "open", "orderindex": 0, "color": "#d3d3d3" } ], "archived": false } ``` -------------------------------- ### GET /spaces Source: https://developer.clickup.com/reference/createspace Retrieves the configuration and feature settings for a specific Space within a ClickUp workspace. ```APIDOC ## GET /spaces ### Description Retrieves the details of a Space, including its status, archived state, and a comprehensive list of enabled features such as time estimates, checklists, and custom fields. ### Method GET ### Endpoint /spaces/{space_id} ### Parameters #### Path Parameters - **space_id** (string) - Required - The unique identifier of the space. ### Request Example GET /api/v2/space/12345 ### Response #### Success Response (200) - **id** (string) - The space ID. - **features** (object) - Object containing enabled/disabled status for various workspace features. - **archived** (boolean) - Indicates if the space is archived. #### Response Example { "id": "p17911545_ABo7jSsf", "status": "complete", "features": { "due_dates": { "enabled": true }, "tags": { "enabled": true }, "time_estimates": { "enabled": true } }, "archived": false } ``` -------------------------------- ### GET /shared Source: https://developer.clickup.com/reference/addguesttolist Retrieves information about shared tasks, lists, and folders. ```APIDOC ## GET /shared ### Description Retrieves a collection of shared resources including tasks, lists, and folders. ### Method GET ### Endpoint /shared ### Parameters #### Path Parameters None #### Query Parameters None ### Request Body None ### Request Example GET /shared ### Response #### Success Response (200) - **tasks** (array) - List of shared task IDs - **lists** (array) - List of shared list objects - **folders** (array) - List of shared folder objects #### Response Example { "tasks": ["task_id_1", "task_id_2"], "lists": [ { "id": "1427", "name": "List Name", "orderindex": 1, "status": null, "priority": null, "assignee": null, "task_count": "5", "due_date": null, "start_date": null, "archived": false, "override_statuses": false, "statuses": [], "permission_level": "read" } ], "folders": [] } ``` -------------------------------- ### ClickUp View Configuration Example Source: https://developer.clickup.com/reference/createfolderview This JSON object represents the configuration for a ClickUp List View. It includes settings for grouping, sorting, filtering, and column display. This structure can be used to define or retrieve view settings. ```json { "view": { "id": "3c-107", "name": "New Folder View Name", "type": "list", "parent": { "id": "457", "type": 5 }, "grouping": { "field": "status", "dir": 1, "collapsed": [], "ignore": false }, "divide": { "field": null, "dir": null, "collapsed": [] }, "sorting": { "fields": [ { "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", "dir": -1, "idx": 0 } ] }, "filters": { "op": "AND", "fields": [ { "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", "op": "EQ", "determinor": null, "idx": 0, "values": "123" } ], "search": "", "show_closed": false }, "columns": { "fields": [ { "field": "assignee", "idx": 0, "width": 160, "hidden": true, "name": null, "display": null } ] }, "team_sidebar": { "assignees": [], "assigned_comments": false, "unassigned_tasks": false }, "settings": { "show_task_locations": false, "show_subtasks": 3, "show_subtask_parent_names": false, "show_closed_subtasks": false, "show_assignees": true, "show_images": true, "collapse_empty_columns": null, "me_comments": true, "me_subtasks": true, "me_checklists": true } } } ``` -------------------------------- ### Example Task Creation Payload Source: https://developer.clickup.com/reference/createtask This JSON payload demonstrates how to create a new task in ClickUp, including various standard and custom fields. Custom fields with object and array types can be set to null. ```json { "name": "New Task Name", "description": "New Task Description", "assignees": [ 183 ], "archived": false, "group_assignees": [ "dd01f92f-48ca-446d-88a1-0beb0e8f5f14" ], "tags": [ "tag name 1" ], "status": "Open", "priority": 3, "due_date": 1508369194377, "due_date_time": false, "time_estimate": 8640000, "start_date": 1567780450202, "start_date_time": false, "points": 3, "notify_all": true, "parent": null, "links_to": null, "check_required_custom_fields": true, "custom_fields": [ { "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", "value": 23 } ] } ``` -------------------------------- ### Create Workspace View (cURL) Source: https://developer.clickup.com/reference/createteamview Use this cURL request to create a new view at the Everything level of your Workspace. Ensure you replace `{team_id}` with your actual Workspace ID. This example demonstrates setting grouping and filter options. ```shell curl --request POST \ --url https://api.clickup.com/api/v2/team//view \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '{ "grouping": { "ignore": true }, "filters": { "show_closed": true }, "team_sidebar": { "assigned_comments": true, "unassigned_tasks": true }, "settings": { "show_task_locations": true, "show_subtask_parent_names": true, "show_closed_subtasks": true, "show_assignees": true, "show_images": true, "me_comments": true, "me_subtasks": true, "me_checklists": true } }' ``` -------------------------------- ### Manual Progress Custom Field Source: https://developer.clickup.com/reference/createtask Update a Manual Progress Custom Field by setting the current progress value. This value must be between the field's start and end points. Refer to 'Get Accessible Custom Fields' for start and end values. Manual Progress Custom Fields can be set to null. ```APIDOC ## Manual Progress Custom Field ### Description Allows updating a Manual Progress Custom Field by setting a `current` progress value. This value must be between the `start` and `end` values defined for the field (obtainable via 'Get Accessible Custom Fields'). Manual Progress Custom Fields can be set to `null`. ### Method Not specified in the provided text, but typically POST or PUT for updates. ### Endpoint Not specified in the provided text. ### Parameters #### Request Body - **id** (string) - Required - The ID of the custom field. - **value** (object) - Required - The value to set for the custom field. - **current** (number) - Required - The current progress value. Must be between the field's start and end values. ### Request Example ```json { "id": "your_custom_field_id", "value": { "current": 20 } } ``` ### Response #### Success Response (200) - **id** (string) - The ID of the custom field. - **value** (object) - The updated value object. - **current** (number) - The current progress value. #### Response Example ```json { "id": "your_custom_field_id", "value": { "current": 20 } } ``` ``` -------------------------------- ### Get All Workspace Tasks API Source: https://developer.clickup.com/reference/createchatchannel Retrieves a list of all tasks within a specified workspace. This endpoint is useful for getting an overview of all outstanding work. ```APIDOC ## GET /api/v2/task ### Description Retrieves all tasks within a workspace. ### Method GET ### Endpoint /api/v2/task ### Parameters #### Query Parameters - **workspace_id** (integer) - Required - The ID of the workspace to retrieve tasks from. - **archived** (boolean) - Optional - Filter tasks by archived status. Defaults to false. - **deleted** (boolean) - Optional - Filter tasks by deleted status. Defaults to false. ### Response #### Success Response (200) - **tasks** (array[object]) - A list of task objects. - **id** (string) - The unique identifier for the task. - **name** (string) - The name of the task. - **created_at** (integer) - The timestamp when the task was created. - **updated_at** (integer) - The timestamp when the task was last updated. - **due_date** (integer | null) - The due date of the task. - **status** (string) - The current status of the task. #### Response Example ```json { "tasks": [ { "id": "task1", "name": "Implement Feature X", "created_at": 1678886400000, "updated_at": 1678972800000, "due_date": 1679059200000, "status": "In Progress" }, { "id": "task2", "name": "Write Documentation", "created_at": 1678886400000, "updated_at": 1678886400000, "due_date": null, "status": "To Do" } ] } ``` #### Error Response (400, 401, 404, 500) - **status** (integer) - The HTTP Status code for the error. - **message** (string) - The message describing the error. - **trace_id** (integer) - Unique trace ID for tracking the request. - **timestamp** (integer) - The time of the error (Unix epoch milliseconds timestamp). ``` ``` -------------------------------- ### GET /task/{task_id}/attachment Source: https://developer.clickup.com/reference/createtaskattachment Retrieves the attachment details for a specific task. ```APIDOC ## GET /task/{task_id}/attachment ### Description Retrieves a list of attachments associated with a specific task, including metadata such as file URLs, thumbnails, and upload dates. ### Method GET ### Endpoint /task/{task_id}/attachment ### Parameters #### Path Parameters - **task_id** (string) - Required - The unique identifier of the task. ### Request Example GET /api/v2/task/12345/attachment ### Response #### Success Response (200) - **id** (string) - The unique identifier of the attachment. - **version** (string) - The version of the attachment. - **date** (number) - The timestamp of the upload. - **title** (string) - The file name. - **extension** (string) - The file extension. - **thumbnail_small** (string) - URL for the small thumbnail. - **thumbnail_large** (string) - URL for the large thumbnail. - **url** (string) - Direct URL to the attachment. #### Response Example { "id": "ac434d4e-8b1c-4571-951b-866b6d9f2ee6.png", "version": "0", "date": 1569988578766, "title": "image.png", "extension": "png", "thumbnail_small": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png", "thumbnail_large": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png", "url": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png" } ``` -------------------------------- ### POST /websites/developer_clickup_reference Source: https://developer.clickup.com/reference/creategoal Adds a new Goal to a specified Workspace. ```APIDOC ## POST /websites/developer_clickup_reference ### Description Adds a new Goal to a Workspace. ### Method POST ### Endpoint /websites/developer_clickup_reference ### Parameters #### Request Body - **name** (string) - Required - The name of the goal. - **description** (string) - Optional - A description for the goal. - **due_date** (integer) - Optional - The due date for the goal in milliseconds. - **start_date** (integer) - Optional - The start date for the goal in milliseconds. - **workspace_id** (string) - Required - The ID of the workspace to add the goal to. - **team_id** (string) - Optional - The ID of the team to associate the goal with. - **owner_ids** (array) - Optional - A list of user IDs who own the goal. - **goal_privacy** (string) - Optional - Privacy setting for the goal ('workspace' or 'team'). - **goal_type** (string) - Optional - Type of goal ('numeric', 'task_count', 'progress'). - **progress** (object) - Optional - Progress details for the goal. - **percent_complete** (number) - Required if goal_type is 'progress' - The percentage completion of the goal. ### Request Example ```json { "name": "Increase Q4 Revenue", "description": "Achieve 15% revenue growth in the fourth quarter.", "due_date": 1704067199000, "workspace_id": "123456789", "team_id": "987654321", "owner_ids": ["user1", "user2"], "goal_type": "numeric", "progress": { "percent_complete": 50 } } ``` ### Response #### Success Response (200) - **goal** (object) - The created goal object. - **id** (string) - The ID of the goal. - **name** (string) - The name of the goal. - **description** (string) - The description of the goal. - **due_date** (integer) - The due date of the goal in milliseconds. - **start_date** (integer) - The start date of the goal in milliseconds. - **workspace_id** (string) - The ID of the workspace. - **team_id** (string) - The ID of the team. - **owner_ids** (array) - A list of user IDs who own the goal. - **goal_privacy** (string) - Privacy setting for the goal. - **goal_type** (string) - Type of goal. - **progress** (object) - Progress details for the goal. - **percent_complete** (number) - Percentage completion of the goal. #### Response Example ```json { "goal": { "id": "goal_abc123", "name": "Increase Q4 Revenue", "description": "Achieve 15% revenue growth in the fourth quarter.", "due_date": 1704067199000, "start_date": 1698883200000, "workspace_id": "123456789", "team_id": "987654321", "owner_ids": ["user1", "user2"], "goal_privacy": "workspace", "goal_type": "numeric", "progress": { "percent_complete": 50 } } } ``` ``` -------------------------------- ### GET /task/{task_id}/checklist Source: https://developer.clickup.com/reference/createchecklistitem Retrieves the checklists associated with a specific task. ```APIDOC ## GET /task/{task_id}/checklist ### Description Retrieves all checklists and their respective items for a given task ID. ### Method GET ### Endpoint /task/{task_id}/checklist ### Parameters #### Path Parameters - **task_id** (string) - Required - The unique identifier of the task. ### Request Example GET /task/9hv/checklist ### Response #### Success Response (200) - **checklist** (object) - The checklist object containing items, status, and metadata. #### Response Example { "checklist": { "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", "task_id": "9hv", "name": "Checklist", "items": [ { "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", "name": "Checklist Item", "resolved": false } ] } } ``` -------------------------------- ### GET /api/v2/workspace/{workspace_id}/folders Source: https://developer.clickup.com/reference/createreplymessage Retrieves a list of all folders within a specified workspace. ```APIDOC ## GET /api/v2/workspace/{workspace_id}/folders ### Description Retrieves a list of all folders within a specified workspace. ### Method GET ### Endpoint /api/v2/workspace/{workspace_id}/folders ### Parameters #### Path Parameters - **workspace_id** (string) - Required - The ID of the workspace. ### Response #### Success Response (200) - **folders** (array) - An array of folder objects. - **id** (string) - The ID of the folder. - **name** (string) - The name of the folder. #### Response Example ```json { "folders": [ { "id": "folderA", "name": "Project Alpha" }, { "id": "folderB", "name": "Project Beta" } ] } ``` ``` -------------------------------- ### POST /folder/{folder_id}/list/template/{template_id} Source: https://developer.clickup.com/reference/createfolderlistfromtemplate Creates a new list from a template within a specified folder. ```APIDOC ## POST /folder/{folder_id}/list/template/{template_id} ### Description Creates a new list using a list template in a Folder. Publicly shared templates must be added to your Workspace before they can be used via the API. ### Method POST ### Endpoint /folder/{folder_id}/list/template/{template_id} ### Parameters #### Path Parameters - **folder_id** (string) - Required - The unique identifier of the folder. - **template_id** (string) - Required - The unique identifier of the template. #### Query Parameters - **return_immediately** (boolean) - Optional - If true, returns the list ID immediately before creation completes. ### Request Example { "name": "New List Name", "content": "List description" } ### Response #### Success Response (200) - **id** (string) - The ID of the newly created list. #### Response Example { "id": "12345" } ``` -------------------------------- ### GET /team/{team_id}/custom_item Source: https://developer.clickup.com/reference/custom-task-types Retrieves the custom task types available in a specified Workspace. ```APIDOC ## GET /team/{team_id}/custom_item ### Description View the custom task types available in a Workspace. ### Method GET ### Endpoint https://api.clickup.com/api/v2/team/{team_id}/custom_item ### Parameters #### Path Parameters - **team_id** (number) - Required - Workspace ID ### Response #### Success Response (200) - **custom_item_types** (array) - A list of custom item types. - **id** (string) - The ID of the custom item type. - **name** (string) - The name of the custom item type. - **workspace_id** (string) - The ID of the workspace. - **task_id** (string) - The ID of the associated task. - **enabled** (boolean) - Whether the custom item type is enabled. - **type** (string) - The type of the custom item. - **field_ids** (array) - A list of field IDs associated with the custom item type. ### Request Example ```json { "example": "request body" } ``` ### Response Example ```json { "custom_item_types": [ { "id": "string", "name": "string", "workspace_id": "string", "task_id": "string", "enabled": true, "type": "string", "field_ids": [ "string" ] } ] } ``` ```