### Example Checklist Object Source: https://developer.clickup.com/reference/editchecklistitem This example demonstrates the structure of a checklist object, including its items and metadata. ```json { "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", "task_id": "9hv", "name": "Checklist", "date_created": "1567711563204", "orderindex": 0, "resolved": 1, "unresolved": 0, "items": [ { "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", "name": "Updated Checklist Item", "orderindex": 0, "assignee": null, "resolved": true, "parent": null, "date_created": "1567711566859", "children": [] } ] } ``` -------------------------------- ### View Object Example Source: https://developer.clickup.com/docs/views This is an example of a view object, illustrating its structure and possible fields. ```APIDOC ## View Object Example ```json { "name": "View Name", "type": "list", "parent": { "id": 333, "type": 7 }, "grouping": { "field": "status", "dir": 1 }, "filters": { "op": "AND", "fields": [ { "field": "assignee", "op": "EQ", "values": [] } ], "search": "", "show_closed": false }, "sorting": { "fields": [ { "field": "dateCreated", "dir": -1 } ] }, "columns": { "fields": [ { "field": "dateCreated" } ] } } ``` ``` -------------------------------- ### Get Dependent Tasks Example Source: https://developer.clickup.com/docs/tasks The GET Task API returns dependent tasks in the response body. This JSON snippet illustrates the structure of the 'dependencies' array. ```json { "dependencies": [ { "task_id": "8xdfm9vmz", "depends_on": "8xdfe67cz", "type": 1, "date_created": "1744930371817", "userid": "395492", "workspace_id": "333", "chain_id": null } ] } ``` -------------------------------- ### Example List View Configuration Source: https://developer.clickup.com/reference/updateview This example demonstrates the structure for creating a new List view, including its name, parent, grouping, sorting, and filtering options. ```json { "name": "New View Name", "type": "list", "parent": { "id": "512", "type": 7 }, "grouping": { "field": "status", "dir": 1, "collapsed": [], "ignore": false }, "divide": { "field": null, "dir": null, "collapsed": [] }, "sorting": { "fields": [] }, "filters": { "op": "AND", "fields": [], "search": "", "show_closed": false } } ``` -------------------------------- ### Get Linked Tasks Example Source: https://developer.clickup.com/docs/tasks The GET Task API returns linked tasks in the response body. This JSON snippet shows the structure of the 'linked_tasks' array. ```json { "linked_tasks": [ { "task_id": "8xdfdjbgd", "link_id": "8xdfm9vmz", "date_created": "1744930048464", "userid": "395492", "workspace_id": "333" } ] } ``` -------------------------------- ### Example List View Configuration Source: https://developer.clickup.com/reference/createlistview An example of a fully configured list view, demonstrating settings for name, type, grouping, sorting, filtering, columns, and team sidebar. ```json { "name": "New List 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 } } ``` -------------------------------- ### Add Guest to Folder Example Source: https://developer.clickup.com/reference/addguesttofolder This example demonstrates the structure of a successful response when a guest is added to a folder. It includes details about the guest, who invited them, their permissions, and the shared folder information. ```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": [], "folders": [ { "id": "1057", "name": "Folder Name", "orderindex": 5, "override_statuses": true, "hidden": false, "task_count": "20", "archived": false, "statuses": [ { "status": "Open", "orderindex": 0, "color": "#d3d3d3", "type": "open" }, { "status": "Closed", "orderindex": 5, "color": "#6bc950", "type": "closed" } ], "lists": [], "permission_level": "read" } ] } } } ``` -------------------------------- ### Get Next Page of Task Comments Source: https://developer.clickup.com/docs/task-comments-pagination To get the next oldest page of comments, use the `id` and `date` from the last comment of the previous response as `start_id` and `start` query parameters. ```bash GET /task/{task_id}/comment?start_id={id}&start={date} ``` -------------------------------- ### Example Settings Object Source: https://developer.clickup.com/reference/updateview Configures various display settings for the view, including task name visibility, subtask options, time tracking, and zoom level. ```json { "content": { "show_task_names": true, "show_assignees": true, "show_due_date": true, "show_priority": true, "show_tags": true, "show_status": true }, "subtasks": { "show_subtasks": true, "subtask_assignees": true, "subtask_due_date": true, "subtask_priority": true, "subtask_tags": true, "subtask_status": true }, "time_estimate": { "enabled": true, "show_estimate_column": true }, "time_tracking": { "enabled": true, "show_tracked_time_column": true }, "zoom": { "enabled": true, "zoom_level": 1 } } ``` -------------------------------- ### Get Webhooks Example Source: https://developer.clickup.com/reference/getwebhooks This example demonstrates how to retrieve webhooks for a given Workspace ID. Ensure you have the correct Workspace ID. The response includes details about each webhook, such as its ID, associated events, and health status. ```json { "openapi": "3.1.0", "info": { "title": "ClickUp API v2 Reference", "description": "The ClickUp API enables you to programmatically access and manage your ClickUp resources.\n\n## Authentication\nThe API supports two authentication methods:\n- **Personal API Token**: Use for testing and personal integrations. Add token to requests with header: `Authorization: pk_...`\n- **OAuth 2.0**: Required for building apps for other users. Uses authorization code flow.\n\n## Getting Started\nOur [Getting Started Guide](https://developer.clickup.com/docs/index) provides a comprehensive overview of how to use the ClickUp API.\n", "contact": {}, "version": "2.0" }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "servers": [ { "url": "https://api.clickup.com/api", "description": "ClickUp", "variables": {} } ], "paths": { "/v2/team/{team_id}/webhook": { "get": { "summary": "Get Webhooks", "tags": [ "Webhooks" ], "description": "View the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user.", "operationId": "GetWebhooks", "parameters": [ { "name": "team_id", "in": "path", "description": "Workspace ID", "required": true, "style": "simple", "schema": { "type": "number", "contentEncoding": "double", "examples": [ 123 ] } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "title": "GetWebhooksresponse", "required": [ "webhooks" ], "type": "object", "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/paths/~1v2~1webhook~1%7Bwebhook_id%7D/put/responses/200/content/application~1json/schema/properties/webhook" }, "description": "" } }, "examples": [ { "webhooks": [ { "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", "userid": 183, "team_id": 108, "endpoint": "https://yourdomain.com/webhook", "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", "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" ], "task_id": null, "list_id": null, "folder_id": null, "space_id": null, "health": { "status": "failing", "fail_count": 5 }, "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA" } ] } ] } } } } } } } } } ``` -------------------------------- ### Create Folder Response Example Source: https://developer.clickup.com/reference/createfolder This is an example of a successful response when creating a folder. It returns the details of the newly created folder, including its ID, name, and associated space information. ```json { "id": "457", "name": "New Folder Name", "orderindex": 0, "override_statuses": false, "hidden": false, "space": { "id": "789", "name": "Space Name", "access": true }, "task_count": "0" } ``` -------------------------------- ### Example Time Entry Response Source: https://developer.clickup.com/reference/getsingulartimeentry This is an example of the JSON response when retrieving a single time entry. It includes details such as timer ID, user information, start and end times, duration, and associated task information. ```json { "id": "timer_id", "wid": "workspace_id", "user": { "id": 1, "username": "first_name last_name", "email": "test@gmail.com", "color": "#08c7e0", "initials": "JK", "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" }, "billable": false, "start": "1592841559129", "end": "1592845899021", "duration": "4339892", "description": "", "source": "clickup", "at": "1592845899021", "task_location": { "list_id": 1560300071, "folder_id": 468300080, "space_id": 22800253, "list_name": "List", "folder_name": "Folder", "space_name": "Space" }, "task_tags": [ { "name": "content-request", "tag_fg": "#800000", "tag_bg": "#2ecd6f", "creator": 301828 }, { "name": "marketing-okr", "tag_fg": "#800000", "tag_bg": "#7C4DFF", "creator": 301828 } ], "task_url": "https://staging.clickup.com/t/rnmuwz7" } ``` -------------------------------- ### Create List View Example Source: https://developer.clickup.com/reference/createlistview This example demonstrates the structure of a request to create a new List View, including its various configuration options. ```APIDOC ## POST /list/{list_id}/view ### Description Creates a new view for a List. ### Method POST ### Endpoint /list/{list_id}/view ### Parameters #### Path Parameters - **list_id** (string) - Required - The ID of the List to create the view in. #### Request Body - **name** (string) - Required - The name of the new view. - **type** (string) - Required - The type of the view. Use `list` for a List View. - **parent** (object) - Required - The parent object of the view. - **id** (string) - Required - The ID of the parent. - **type** (integer) - Required - The type of the parent (e.g., 6 for List). - **grouping** (object) - Optional - Configuration for grouping tasks within the view. - **field** (string) - Required - The field to group by (e.g., `status`). - **dir** (integer) - Required - The direction of the grouping (1 for ascending, -1 for descending). - **collapsed** (array) - Optional - An array of group IDs that should be collapsed. - **ignore** (boolean) - Optional - Whether to ignore grouping. - **divide** (object) - Optional - Configuration for dividing tasks within the view. - **field** (string) - Required - The field to divide by. - **dir** (integer) - Required - The direction of the division (1 for ascending, -1 for descending). - **collapsed** (array) - Optional - An array of division IDs that should be collapsed. - **sorting** (object) - Optional - Configuration for sorting tasks within the view. - **fields** (array) - Required - An array of sorting configurations. - **field** (string) - Required - The field to sort by. - **dir** (integer) - Required - The direction of the sort (1 for ascending, -1 for descending). - **idx** (integer) - Required - The index of the sort field. - **filters** (object) - Optional - Configuration for filtering tasks within the view. - **op** (string) - Required - The logical operator for the filters (e.g., `AND`, `OR`). - **fields** (array) - Required - An array of filter conditions. - **field** (string) - Required - The field to filter on. - **op** (string) - Required - The operator for the filter (e.g., `EQ`, `GT`, `LT`). - **determinor** (any) - Optional - The determinor for the filter. - **idx** (integer) - Required - The index of the filter. - **values** (string) - Required - The value(s) to filter by. - **search** (string) - Optional - A search string to filter tasks. - **show_closed** (boolean) - Optional - Whether to show closed tasks. - **columns** (object) - Optional - Configuration for the columns displayed in the view. - **fields** (array) - Required - An array of column configurations. - **field** (string) - Required - The field representing the column. - **idx** (integer) - Required - The index of the column. - **width** (integer) - Optional - The width of the column. - **hidden** (boolean) - Optional - Whether the column is hidden. - **name** (any) - Optional - The name of the column. - **display** (any) - Optional - The display setting for the column. - **team_sidebar** (object) - Optional - Configuration for the team sidebar. - **assignees** (array) - Optional - Assignees to display. - **assigned_comments** (boolean) - Optional - Whether to show assigned comments. - **unassigned_tasks** (boolean) - Optional - Whether to show unassigned tasks. - **settings** (object) - Optional - General settings for the view. - **show_task_locations** (boolean) - Optional - Whether to show task locations. - **show_subtasks** (integer) - Optional - How to show subtasks (e.g., 3). - **show_subtask_parent_names** (boolean) - Optional - Whether to show subtask parent names. - **show_closed_subtasks** (boolean) - Optional - Whether to show closed subtasks. - **show_assignees** (boolean) - Optional - Whether to show assignees. - **show_images** (boolean) - Optional - Whether to show images. - **collapse_empty_columns** (any) - Optional - Setting for collapsing empty columns. - **me_comments** (boolean) - Optional - Whether to show comments assigned to the current user. - **me_subtasks** (boolean) - Optional - Whether to show subtasks assigned to the current user. - **me_checklists** (boolean) - Optional - Whether to show checklists assigned to the current user. ### Request Example ```json { "name": "New List View Name", "type": "list", "parent": { "id": "124", "type": 6 }, "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 } } ``` ### Response #### Success Response (200) - **view** (object) - The created view object. - **id** (string) - The ID of the created view. - **name** (string) - The name of the created view. - **type** (string) - The type of the created view. - **parent** (object) - The parent object of the view. - **grouping** (object) - The grouping configuration. - **divide** (object) - The division configuration. - **sorting** (object) - The sorting configuration. - **filters** (object) - The filter configuration. - **columns** (object) - The column configuration. - **team_sidebar** (object) - The team sidebar configuration. - **settings** (object) - The view settings. #### Response Example ```json { "view": { "id": "3c-108", "name": "New List View Name", "type": "list", "parent": { "id": "124", "type": 6 }, "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 } } } ``` ``` -------------------------------- ### Get List Views OpenAPI Definition Source: https://developer.clickup.com/reference/getlistviews This JSON object defines the OpenAPI specification for the 'Get List Views' API endpoint. It includes details on the request parameters, expected responses, and an example response structure. ```json { "openapi": "3.1.0", "info": { "title": "ClickUp API v2 Reference", "description": "The ClickUp API enables you to programmatically access and manage your ClickUp resources.\n\n## Authentication\nThe API supports two authentication methods:\n- **Personal API Token**: Use for testing and personal integrations. Add token to requests with header: `Authorization: pk_...`\n- **OAuth 2.0**: Required for building apps for other users. Uses authorization code flow.\n\n## Getting Started\nOur [Getting Started Guide](https://developer.clickup.com/docs/index) provides a comprehensive overview of how to use the ClickUp API.\n", "contact": {}, "version": "2.0" }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "servers": [ { "url": "https://api.clickup.com/api", "description": "ClickUp", "variables": {} } ], "paths": { "/v2/list/{list_id}/view": { "get": { "summary": "Get List Views", "tags": [ "Views" ], "description": "View the task and page views available for a List.\\ \nViews and required views are separate responses.", "operationId": "GetListViews", "parameters": [ { "name": "list_id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "number", "contentEncoding": "double", "examples": [ 124 ] } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "title": "GetListViewsresponse", "type": "object", "properties": { "views": { "type": "array", "items": { "$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/oneOf/0" }, "description": "" } }, "examples": [ { "views": [ { "id": "3c-107", "name": "New List View Name", "type": "list", "parent": { "id": "124", "type": 6 }, "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 } } ] } ] }, "example": { "views": [ { "id": "3c-107", "name": "New List View Name", "type": "list", "parent": { "id": "124", "type": 6 }, "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 } } ] } } } } } } } } } ``` -------------------------------- ### Settings Object Example Source: https://developer.clickup.com/reference/updateview This example shows a comprehensive 'settings' object for a view, including options for task locations, subtasks, assignees, images, and comment visibility. ```json { "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 } ``` -------------------------------- ### Edit Time Tracked Request Body Example Source: https://developer.clickup.com/reference/edittimetracked This example demonstrates the structure of the JSON request body required to edit a time tracked entry. It includes fields for start time, end time, and total time. ```json { "start": 1567780450202, "end": 1508369194377, "time": 8640000 } ``` -------------------------------- ### Example View Configuration: Status Source: https://developer.clickup.com/reference/updateview An example of how to configure view settings related to status, including direction and collapsed states. ```json { "field": "status", "dir": 1, "collapsed": [], "ignore": false } ``` -------------------------------- ### Get List Templates Response Example Source: https://developer.clickup.com/reference/getlisttemplates This JSON structure represents a successful response from the Get List Templates endpoint, showing an array of available templates with their names and unique IDs. Template IDs are prefixed with 't-'. ```json { "templates": [ { "name": "List Template 1", "id": "t-15363293" }, { "name": "List Template 2", "id": "t-15363298" } ] } ``` -------------------------------- ### Get List Comments Source: https://developer.clickup.com/llms.txt View the comments added to a List. If `start` and `start_id` parameters are not included, this endpoint returns the most recent 25 comments. Use `start` and `start_id` of the oldest comment to retrieve the next 25 comments. ```APIDOC ## GET /list/{list_id}/comment ### Description View the comments added to a List. ### Method GET ### Endpoint /list/{list_id}/comment ### Query Parameters - **start** (integer) - Optional - The starting point for retrieving comments. - **start_id** (integer) - Optional - The ID of the starting comment for retrieving comments. ``` -------------------------------- ### Example Create List View Response Source: https://developer.clickup.com/reference/createlistview An example of a successful response after creating a list view. It includes the 'view' object with its ID, name, type, parent, and configuration details. ```json { "view": { "id": "3c-108", "name": "New List View Name", "type": "list", "parent": { "id": "124", "type": 6 }, "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": [] } } } ``` -------------------------------- ### Get Chat View Comments Source: https://developer.clickup.com/llms.txt View comments from a Chat view. If `start` and `start_id` parameters are not included, this endpoint returns the most recent 25 comments. Use `start` and `start_id` of the oldest comment to retrieve the next 25 comments. ```APIDOC ## GET /chat/{chat_id}/comment ### Description View comments from a Chat view. ### Method GET ### Endpoint /chat/{chat_id}/comment ### Query Parameters - **start** (integer) - Optional - The starting point for retrieving comments. - **start_id** (integer) - Optional - The ID of the starting comment for retrieving comments. ``` -------------------------------- ### Example User Group Creation Request Source: https://developer.clickup.com/reference/createusergroup An example of how to structure the request body for creating a user group, including sample data for name, handle, and members. ```json { "name": "New team name", "handle": "newteamname", "members": [ 123456, 987654 ] } ``` -------------------------------- ### Create Key Result Request Body Example Source: https://developer.clickup.com/reference/createkeyresult This example demonstrates the structure of a JSON request body to create a new Key Result. It specifies the name, owners, type, start and end steps, unit, and associated tasks and lists. ```json { "name": "New Key Result Name", "owners": [ 183 ], "type": "number", "steps_start": 0, "steps_end": 10, "unit": "km", "task_ids": [], "list_ids": [] } ``` -------------------------------- ### Create Task Response Example Source: https://developer.clickup.com/reference/createtask This example shows the structure of a successful response when creating a task. It includes the newly created task's ID, name, status, creator information, and custom field details. ```json { "id": "9hx", "custom_id": null, "custom_item_id": 0, "name": "New Task Name", "text_content": "New Task Content", "description": "New Task Content", "markdown_description": "New Task Content", "status": { "id": "p7002367_HxJmgqni", "status": "to do", "color": "#f8ae00", "orderindex": 0, "type": "open" }, "orderindex": "1.00000000000000000000000000000000", "date_created": "1567780450202", "date_updated": "1567780450202", "date_closed": null, "date_done": null, "archived": false, "creator": { "id": 183, "username": "Alex Johnson", "color": "#827718", "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" }, "assignees": [], "group_assignees": [], "watchers": [], "checklists": [], "tags": [], "parent": null, "top_level_parent": null, "priority": { "color": "#f8ae00", "id": "3", "orderindex": "3", "priority": "normal" }, "due_date": "1508369194377", "start_date": null, "points": 3, "time_estimate": "8640000", "time_spent": 0, "custom_fields": [ { "id": "d2ab17e0-41d3-4d28-bdbb-f3f0f2c62f8b", "name": "Sprint Goal", "type": "short_text", "type_config": {}, "date_created": "1621915186877", "hide_from_guests": false, "value": "Fix critical auth issues", "value_richtext": "", "required": false }, { "id": "1f3cc395-3448-4264-bedd-590a3b3fa178", "name": "Story Points", "type": "dropdown", "type_config": {}, "date_created": "1621915186877", "hide_from_guests": false, "value": 3, "required": false } ] } ``` -------------------------------- ### Example View Configuration: Divide Source: https://developer.clickup.com/reference/updateview An example of the 'divide' configuration for a view, typically used for grouping or partitioning data. ```json { "field": null, "dir": null, "collapsed": [] } ``` -------------------------------- ### Get Time Entries Source: https://developer.clickup.com/reference/gettimeentrieswithinadaterange Fetches time entries for a specified date range within a team. You can filter by start and end dates to narrow down the results. ```APIDOC ## GET /v2/team/{team_Id}/time_entries ### Description Retrieves a list of time entries within a specified date range for a given team. ### Method GET ### Endpoint /v2/team/{team_Id}/time_entries ### Parameters #### Query Parameters - **start_date** (integer) - Required - The start date for the time range in milliseconds since the Unix epoch. - **end_date** (integer) - Required - The end date for the time range in milliseconds since the Unix epoch. ### Response #### Success Response (200) - **data** (array) - An array of time entry objects. - **id** (string) - The unique identifier for the time entry. - **task** (object) - Information about the task associated with the time entry. - **id** (string) - The task ID. - **custom_id** (string) - The custom ID of the task. - **name** (string) - The name of the task. - **status** (object) - The status of the task. - **status** (string) - The name of the status. - **color** (string) - The color associated with the status. - **type** (string) - The type of the status (e.g., 'open', 'closed'). - **orderindex** (integer) - The order index of the status. - **custom_type** (string or null) - The custom type of the task. - **wid** (string) - The workspace ID. - **user** (object) - Information about the user who logged the time. - **id** (integer) - The user ID. - **username** (string) - The username. - **email** (string) - The user's email. - **color** (string) - The user's color. - **initials** (string) - The user's initials. - **profilePicture** (string) - URL to the user's profile picture. - **billable** (boolean) - Indicates if the time entry is billable. - **start** (integer) - The start time of the entry in milliseconds. - **end** (integer) - The end time of the entry in milliseconds. - **duration** (string) - The duration of the time entry in milliseconds. - **description** (string) - A description for the time entry. - **tags** (array) - An array of tags associated with the time entry. - **source** (string) - The source of the time entry (e.g., 'clickup'). - **at** (string) - The timestamp when the entry was last updated. - **approval_id** (string) - The ID of the approval associated with the time entry. - **approval** (object) - Details about the approval. - **task_location** (object) - Location details of the task within the workspace. - **list_id** (integer) - The list ID. - **folder_id** (integer) - The folder ID. - **space_id** (integer) - The space ID. - **list_name** (string) - The name of the list. - **folder_name** (string) - The name of the folder. - **space_name** (string) - The name of the space. - **task_tags** (array) - Tags specifically applied to the task. - **name** (string) - The name of the task tag. - **tag_fg** (string) - Foreground color of the tag. - **tag_bg** (string) - Background color of the tag. - **creator** (integer) - The ID of the user who created the tag. - **task_url** (string) - The URL to the task. #### Response Example ```json { "data": [ { "id": "1963465985517105840", "task": { "id": "1vwwavv", "custom_id": "JOSH-917", "name": "woof", "status": { "status": "open yes", "color": "#d3d3d3", "type": "open", "orderindex": 0 }, "custom_type": null }, "wid": "300702", "user": { "id": 1, "username": "first_name last_name", "email": "test@gmail.com", "color": "#08c7e0", "initials": "JK", "profilePicture": "https://attachments.clickup.com/profilePictures/1_HHk.jpg" }, "billable": false, "start": 1592841559129, "end": 1592845899021, "duration": "4339892", "description": "", "tags": [], "source": "clickup", "at": "1592845899021", "approval_id": "2d539936-119a-4927-9770-179f0a72e2e5", "approval": {}, "task_location": { "list_id": 1560300071, "folder_id": 468300080, "space_id": 22800253, "list_name": "List", "folder_name": "Folder", "space_name": "Space" }, "task_tags": [ { "name": "content-request", "tag_fg": "#800000", "tag_bg": "#2ecd6f", "creator": 301828 }, { "name": "marketing-okr", "tag_fg": "#800000", "tag_bg": "#7C4DFF", "creator": 301828 } ], "task_url": "https://staging.clickup.com/t/1vwwavv" } ] } ```