CreateListViewresponse
{
"type": "object",
"title": "CreateListViewresponse",
"example": {
"view": {
"id": "3c-108X",
"name": "New List View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "124X",
"type": 6
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
},
"required": [
"view"
],
"properties": {
"view": {
"$ref": "#/components/schemas/View"
}
},
"x-examples": [
{
"view": {
"id": "3c-108X",
"name": "New List View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "124X",
"type": 6
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
}
]
}
CreateListrequest
{
"type": "object",
"title": "CreateListrequest",
"example": {
"name": "New List Name",
"status": "red",
"content": "New List Content",
"assignee": 183,
"due_date": 1567780450202,
"priority": 1,
"due_date_time": false
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"description": "**Status** refers to the List color rather than the task Statuses available in the List."
},
"content": {
"type": "string"
},
"assignee": {
"type": "integer",
"description": "Include a `user_id` to assign this List.",
"contentEncoding": "int32"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"due_date_time": {
"type": "boolean"
}
},
"x-examples": [
{
"name": "New List Name",
"status": "red",
"content": "New List Content",
"assignee": 183,
"due_date": 1567780450202,
"priority": 1,
"due_date_time": false
}
]
}
CreateListresponse
{
"type": "object",
"title": "CreateListresponse",
"example": {
"id": "124X",
"name": "New List Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"folder": {
"id": "456X",
"name": "Folder Name",
"access": true,
"hidden": false
},
"status": {
"color": "#e50000",
"status": "red",
"hide_label": true
},
"content": "New List Content",
"assignee": {
"id": 183,
"color": "#827718",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "urgent"
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"orderindex": 1,
"start_date": null,
"task_count": null,
"due_date_time": false,
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
"start_date_time": null
},
"required": [
"id",
"name",
"orderindex",
"content",
"status",
"priority",
"assignee",
"task_count",
"due_date",
"due_date_time",
"start_date",
"start_date_time",
"folder",
"space",
"statuses",
"inbound_address"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"space": {
"$ref": "#/components/schemas/Space2"
},
"folder": {
"$ref": "#/components/schemas/Folder3"
},
"status": {
"$ref": "#/components/schemas/Status5"
},
"content": {
"type": "string"
},
"assignee": {
"$ref": "#/components/schemas/Assignee3"
},
"due_date": {
"type": "string"
},
"priority": {
"$ref": "#/components/schemas/Priority1"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Status"
},
"description": ""
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"start_date": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": [
"string",
"null"
]
},
"due_date_time": {
"type": "boolean"
},
"inbound_address": {
"type": "string"
},
"start_date_time": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": "124X",
"name": "New List Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"folder": {
"id": "456X",
"name": "Folder Name",
"access": true,
"hidden": false
},
"status": {
"color": "#e50000",
"status": "red",
"hide_label": true
},
"content": "New List Content",
"assignee": {
"id": 183,
"color": "#827718",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "urgent"
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"orderindex": 1,
"start_date": null,
"task_count": null,
"due_date_time": false,
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
"start_date_time": null
}
]
}
CreateSpaceTagrequest
{
"type": "object",
"title": "CreateSpaceTagrequest",
"example": {
"tag": {
"name": "Tag Name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
},
"required": [
"tag"
],
"properties": {
"tag": {
"$ref": "#/components/schemas/Tag"
}
},
"x-examples": [
{
"tag": {
"name": "Tag Name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
}
]
}
CreateSpaceViewrequest
{
"type": "object",
"title": "CreateSpaceViewrequest",
"example": {
"name": "New Space View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
},
"required": [
"name",
"type",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
},
"divide": {
"$ref": "#/components/schemas/Divide"
},
"columns": {
"$ref": "#/components/schemas/Columns"
},
"filters": {
"$ref": "#/components/schemas/Filters"
},
"sorting": {
"$ref": "#/components/schemas/Sorting"
},
"grouping": {
"$ref": "#/components/schemas/Grouping"
},
"settings": {
"$ref": "#/components/schemas/Settings"
},
"team_sidebar": {
"$ref": "#/components/schemas/TeamSidebar"
}
},
"x-examples": [
{
"name": "New Space View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
]
}
CreateSpaceViewresponse
{
"type": "object",
"title": "CreateSpaceViewresponse",
"example": {
"view": {
"id": "3c-106X",
"name": "New Space View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "790X",
"type": 4
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": {
"dir": -1,
"idx": 0,
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2"
}
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
},
"required": [
"view"
],
"properties": {
"view": {
"$ref": "#/components/schemas/View"
}
},
"x-examples": [
{
"view": {
"id": "3c-106X",
"name": "New Space View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "790X",
"type": 4
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": {
"dir": -1,
"idx": 0,
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2"
}
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
}
]
}
CreateSpacerequest
{
"type": "object",
"title": "CreateSpacerequest",
"example": {
"name": "New Space Name",
"features": {
"tags": {
"enabled": true
},
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
}
},
"multiple_assignees": true
},
"required": [
"name",
"multiple_assignees",
"features"
],
"properties": {
"name": {
"type": "string"
},
"features": {
"$ref": "#/components/schemas/Features"
},
"multiple_assignees": {
"type": "boolean"
}
},
"x-examples": [
{
"name": "New Space Name",
"features": {
"tags": {
"enabled": true
},
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
}
},
"multiple_assignees": true
}
]
}
CreateSpaceresponse
{
"type": "object",
"title": "CreateSpaceresponse",
"example": {
"id": "790X",
"name": "New Space Name",
"private": false,
"archived": false,
"features": {
"tags": {
"enabled": true
},
"zoom": {
"enabled": false
},
"emails": {
"enabled": true
},
"points": {
"enabled": false
},
"sprints": {
"enabled": false
},
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"milestones": {
"enabled": false
},
"portfolios": {
"enabled": true
},
"custom_items": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"multiple_assignees": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
}
},
"statuses": [
{
"id": "p16911531_p8y2WNC6X",
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"id": "p17911545_ABo7jSsfX",
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"multiple_assignees": true
},
"required": [
"id",
"name",
"private",
"statuses",
"multiple_assignees",
"features",
"archived"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"features": {
"$ref": "#/components/schemas/Features1"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Status15"
},
"description": ""
},
"multiple_assignees": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "790X",
"name": "New Space Name",
"private": false,
"archived": false,
"features": {
"tags": {
"enabled": true
},
"zoom": {
"enabled": false
},
"emails": {
"enabled": true
},
"points": {
"enabled": false
},
"sprints": {
"enabled": false
},
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"milestones": {
"enabled": false
},
"portfolios": {
"enabled": true
},
"custom_items": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"multiple_assignees": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
}
},
"statuses": [
{
"id": "p16911531_p8y2WNC6X",
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"id": "p17911545_ABo7jSsfX",
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"multiple_assignees": true
}
]
}
CreateTaskAttachmentresponse
{
"type": "object",
"title": "CreateTaskAttachmentresponse",
"example": {
"id": "ac434d4e-8b1c-4571-951b-866b6d9f2ee6.pngX",
"url": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png",
"date": 1569988578766,
"title": "image.png",
"version": "0",
"extension": "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"
},
"required": [
"id",
"version",
"date",
"title",
"extension",
"thumbnail_small",
"thumbnail_large",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
},
"title": {
"type": "string"
},
"version": {
"type": "string"
},
"extension": {
"type": "string"
},
"thumbnail_large": {
"type": "string"
},
"thumbnail_small": {
"type": "string"
}
},
"x-examples": [
{
"id": "ac434d4e-8b1c-4571-951b-866b6d9f2ee6.pngX",
"url": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png",
"date": 1569988578766,
"title": "image.png",
"version": "0",
"extension": "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"
}
]
}
CreateTaskCommentrequest
{
"type": "object",
"title": "CreateTaskCommentrequest",
"example": {
"assignee": 183,
"notify_all": true,
"comment_text": "Task comment content"
},
"required": [
"comment_text",
"assignee",
"notify_all"
],
"properties": {
"assignee": {
"type": "integer",
"contentEncoding": "int32"
},
"notify_all": {
"type": "boolean",
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."
},
"comment_text": {
"type": "string"
}
},
"x-examples": [
{
"assignee": 183,
"notify_all": true,
"comment_text": "Task comment content"
}
]
}
CreateTaskCommentresponse
{
"type": "object",
"title": "CreateTaskCommentresponse",
"example": {
"id": "458X",
"date": 1568036964079,
"hist_id": "26508"
},
"required": [
"id",
"hist_id",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
},
"hist_id": {
"type": "string"
}
},
"x-examples": [
{
"id": "458X",
"date": 1568036964079,
"hist_id": "26508"
}
]
}
CreateTaskFromTemplaterequest
{
"type": "object",
"title": "CreateTaskFromTemplaterequest",
"example": {
"name": "New task name"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
},
"x-examples": [
{
"name": "New task name"
}
]
}
CreateTaskrequest
{
"type": "object",
"title": "CreateTaskrequest",
"example": {
"name": "New Task Name",
"tags": [
"tag name 1"
],
"parent": null,
"status": "Open",
"due_date": 1508369194377,
"links_to": null,
"priority": 3,
"assignees": [
183
],
"notify_all": true,
"start_date": 1567780450202,
"description": "New Task Description",
"custom_fields": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131cX",
"value": 23
},
{
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5X",
"value": "Text field input"
}
],
"due_date_time": false,
"time_estimate": 8640000,
"start_date_time": false,
"check_required_custom_fields": true
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parent": {
"type": [
"string",
"null"
],
"description": "You can create a subtask by including an existing task ID.\\\n \\\nThe `parent` task ID you include cannot be a subtask, and must be in the same List specified in the path parameter."
},
"status": {
"type": "string"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"links_to": {
"type": [
"string",
"null"
],
"description": "Include a task ID to create a linked dependency with your new task."
},
"priority": {
"type": [
"integer",
"null"
],
"contentEncoding": "int32"
},
"assignees": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"notify_all": {
"type": "boolean",
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."
},
"start_date": {
"type": "integer",
"contentEncoding": "int64"
},
"description": {
"type": "string"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFields6"
},
"description": "[Filter by Custom Fields.](https://clickup.com/api)"
},
"due_date_time": {
"type": "boolean"
},
"time_estimate": {
"type": "integer",
"contentEncoding": "int32"
},
"custom_item_id": {
"type": "number",
"description": "To create a task that doesn't use a custom task type, either don't include this field in the request body, or send `'null'`. \\\n \\\nTo create this task as a Milestone, send a value of `1`.\\\n \\\nTo use a custom task type, send the custom task type ID as defined in your Workspace, such as `2`."
},
"start_date_time": {
"type": "boolean"
},
"check_required_custom_fields": {
"type": "boolean",
"description": "When creating a task via API any required Custom Fields are ignored by default (`false`).\\\n \\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`."
}
},
"x-examples": [
{
"name": "New Task Name",
"tags": [
"tag name 1"
],
"parent": null,
"status": "Open",
"due_date": 1508369194377,
"links_to": null,
"priority": 3,
"assignees": [
183
],
"notify_all": true,
"start_date": 1567780450202,
"description": "New Task Description",
"custom_fields": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131cX",
"value": 23
},
{
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5X",
"value": "Text field input"
}
],
"due_date_time": false,
"time_estimate": 8640000,
"start_date_time": false,
"check_required_custom_fields": true
}
]
}
CreateTaskresponse
{
"type": "object",
"title": "CreateTaskresponse.yaml",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"list": {
"$ref": "#/components/schemas/List"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"space": {
"$ref": "#/components/schemas/Space"
},
"folder": {
"$ref": "#/components/schemas/Folder"
},
"parent": {
"type": [
"string",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Status"
},
"creator": {
"$ref": "#/components/schemas/Creator"
},
"due_date": {
"type": [
"string",
"null"
]
},
"priority": {
"type": [
"string",
"null"
]
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"custom_id": {
"type": [
"string",
"null"
]
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"orderindex": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"time_spent": {
"type": [
"string",
"null"
]
},
"date_closed": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"text_content": {
"type": "string"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFields8"
},
"description": ""
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"custom_item_id": {
"type": [
"number",
"null"
],
"description": "A `null` value means this item is a task. A value of `1` is a Milestone. Any other number is a custom task type."
}
}
}
CreateTeamViewrequest
{
"type": "object",
"title": "CreateTeamViewrequest",
"example": {
"name": "New Team View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
},
"required": [
"name",
"type",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
},
"divide": {
"$ref": "#/components/schemas/Divide"
},
"columns": {
"$ref": "#/components/schemas/Columns"
},
"filters": {
"$ref": "#/components/schemas/Filters"
},
"sorting": {
"$ref": "#/components/schemas/Sorting"
},
"grouping": {
"$ref": "#/components/schemas/Grouping"
},
"settings": {
"$ref": "#/components/schemas/Settings"
},
"team_sidebar": {
"$ref": "#/components/schemas/TeamSidebar"
}
},
"x-examples": [
{
"name": "New Team View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
]
}
CreateTeamViewresponse
{
"type": "object",
"title": "CreateTeamViewresponse",
"example": {
"view": {
"id": "3c-105X",
"name": "New Team View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "512X",
"type": 7
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
},
"required": [
"view"
],
"properties": {
"view": {
"$ref": "#/components/schemas/View"
}
},
"x-examples": [
{
"view": {
"id": "3c-105X",
"name": "New Team View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "512X",
"type": 7
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
}
]
}
CreateTeamrequest
{
"type": "object",
"title": "CreateTeamrequest",
"example": {
"name": "New team name",
"members": [
123456,
987654
]
},
"required": [
"name",
"members"
],
"properties": {
"name": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"x-examples": [
{
"name": "New team name",
"members": [
123456,
987654
]
}
]
}
CreateTeamresponse
{
"type": "object",
"title": "CreateTeamresponse",
"example": {
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870dX",
"name": "User group",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "usergroup",
"userid": 301828,
"members": [
{
"id": 185,
"color": "#4169E1",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
{
"id": 186,
"color": "#4169E1",
"email": "alex@example.com",
"initials": "A",
"username": "Alex",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
],
"team_id": "301540",
"initials": "U",
"date_created": "1640122639829"
},
"required": [
"id",
"team_id",
"userid",
"name",
"handle",
"date_created",
"initials",
"members",
"avatar"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"avatar": {
"$ref": "#/components/schemas/Avatar"
},
"handle": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Members1"
},
"description": ""
},
"team_id": {
"type": "string"
},
"initials": {
"type": "string"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870dX",
"name": "User group",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "usergroup",
"userid": 301828,
"members": [
{
"id": 185,
"color": "#4169E1",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
{
"id": 186,
"color": "#4169E1",
"email": "alex@example.com",
"initials": "A",
"username": "Alex",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
],
"team_id": "301540",
"initials": "U",
"date_created": "1640122639829"
}
]
}
CreateWebhookrequest
{
"type": "object",
"title": "CreateWebhookrequest",
"example": {
"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"
],
"list_id": 9876,
"task_id": "abc1234",
"endpoint": "https://yourdomain.com/webhook",
"space_id": 1234,
"folder_id": 5678
},
"required": [
"endpoint",
"events"
],
"properties": {
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"list_id": {
"type": "integer"
},
"task_id": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"space_id": {
"type": "integer"
},
"folder_id": {
"type": "integer"
}
},
"x-examples": [
{
"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"
],
"list_id": 9876,
"task_id": "abc1234",
"endpoint": "https://yourdomain.com/webhook",
"space_id": 1234,
"folder_id": 5678
}
]
}
CreateWebhookresponse
{
"type": "object",
"title": "CreateWebhookresponse",
"example": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435eX",
"webhook": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435eX",
"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"
],
"health": {
"status": "active",
"fail_count": 0
},
"secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA",
"userid": 183,
"list_id": null,
"task_id": null,
"team_id": 108,
"endpoint": "https://yourdomain.com/webhook",
"space_id": null,
"client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO",
"folder_id": null
}
},
"required": [
"id",
"webhook"
],
"properties": {
"id": {
"type": "string"
},
"webhook": {
"$ref": "#/components/schemas/Webhook"
}
},
"x-examples": [
{
"id": "4b67ac88-e506-4a29-9d42-26e504e3435eX",
"webhook": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435eX",
"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"
],
"health": {
"status": "active",
"fail_count": 0
},
"secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA",
"userid": 183,
"list_id": null,
"task_id": null,
"team_id": 108,
"endpoint": "https://yourdomain.com/webhook",
"space_id": null,
"client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO",
"folder_id": null
}
}
]
}
Createatimeentryrequest
{
"type": "object",
"title": "Createatimeentryrequest",
"example": {
"end": 1595282660000,
"tid": "task_id",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"start": 1595282645000,
"assignee": 1,
"billable": true,
"duration": 50000,
"description": "from api"
},
"required": [
"start",
"duration"
],
"properties": {
"end": {
"type": "integer",
"contentEncoding": "int64"
},
"tid": {
"type": "string"
},
"stop": {
"type": "integer",
"description": "The `duration` parameter can be used instead of the `stop` parameter. ",
"contentEncoding": "int64"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags6"
},
"description": "Users on the Business Plan and above can include a time tracking label."
},
"start": {
"type": "integer",
"contentEncoding": "int64"
},
"assignee": {
"type": "integer",
"description": "Workspace owners and admins can include any user id. Workspace members can only include their own user id.",
"contentEncoding": "int32"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "integer",
"description": "When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter.",
"contentEncoding": "int32"
},
"description": {
"type": "string"
}
},
"x-examples": [
{
"end": 1595282660000,
"tid": "task_id",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"start": 1595282645000,
"assignee": 1,
"billable": true,
"duration": 50000,
"description": "from api"
}
]
}
Createatimeentryresponse
{
"type": "object",
"title": "Createatimeentryresponse",
"example": {
"tid": "task_id",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#BF55EC"
}
],
"start": 1595282645000,
"assignee": 1,
"billable": true,
"duration": 50000,
"description": "from api"
},
"required": [
"description",
"tags",
"start",
"billable",
"duration",
"assignee",
"tid"
],
"properties": {
"tid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags6"
},
"description": ""
},
"start": {
"type": "integer",
"contentEncoding": "int64"
},
"assignee": {
"type": "integer",
"contentEncoding": "int32"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
},
"description": {
"type": "string"
}
},
"x-examples": [
{
"tid": "task_id",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#BF55EC"
}
],
"start": 1595282645000,
"assignee": 1,
"billable": true,
"duration": 50000,
"description": "from api"
}
]
}
Creator
{
"type": "object",
"title": "Creator",
"example": {
"id": 183,
"color": "#827718",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"required": [
"id",
"username",
"color",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
}
Creator5
{
"type": "object",
"title": "Creator5",
"example": {
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
},
"required": [
"id",
"username",
"color",
"email",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
]
}
CurrentStatus
{
"type": "object",
"title": "CurrentStatus",
"example": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21708
}
},
"required": [
"status",
"color",
"total_time"
],
"properties": {
"color": {
"type": "string"
},
"status": {
"type": "string"
},
"total_time": {
"$ref": "#/components/schemas/TotalTime"
}
},
"x-examples": [
{
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21708
}
}
]
}
CustomFields
{
"type": "object",
"title": "CustomFields",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
CustomFields6
{
"type": "object",
"title": "CustomFields6",
"example": {
"id": "0a52c486-5f05-403b-b4fd-c512ff05131cX",
"value": 23
},
"required": [
"id",
"value"
],
"properties": {
"id": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "integer",
"contentEncoding": "int32"
},
{
"type": "string"
}
]
}
},
"x-examples": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131cX",
"value": 23
}
]
}
CustomFields7
{
"type": "object",
"title": "CustomFields7",
"example": {
"id": "0a52c486-5f05-403b-b4fd-c512ff05131cX",
"name": "My Number field",
"type": "checkbox",
"value": "23",
"required": true,
"type_config": {},
"date_created": "1622176979540",
"hide_from_guests": false
},
"required": [
"id",
"name",
"type",
"type_config",
"date_created",
"hide_from_guests",
"required"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"required": {
"type": "boolean"
},
"type_config": {
"$ref": "#/components/schemas/TypeConfig1"
},
"date_created": {
"type": "string"
},
"hide_from_guests": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131cX",
"name": "My Number field",
"type": "checkbox",
"value": "23",
"required": true,
"type_config": {},
"date_created": "1622176979540",
"hide_from_guests": false
}
]
}
CustomFields8
{
"type": "object",
"title": "CustomFields8",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"oneOf": [
{
"$ref": "#/components/schemas/Value"
},
{
"$ref": "#/components/schemas/Value1"
},
{
"$ref": "#/components/schemas/Value2"
}
],
"example": {
"id": 183,
"color": "#7b68ee",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": null
},
"x-examples": [
{
"id": 183,
"color": "#7b68ee",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": null
},
{
"value": null
}
]
},
"required": {
"type": "boolean"
},
"type_config": {
"$ref": "#/components/schemas/TypeConfig1"
},
"date_created": {
"type": "string"
},
"hide_from_guests": {
"type": "boolean"
}
}
}
CustomFields9
{
"type": "object",
"title": "CustomFields9",
"example": {
"id": "be43f58e-989e-4233-9f25-27584f094b74X",
"name": "Location type Custom Field",
"type": "location",
"required": false,
"type_config": {},
"date_created": "1617765143523",
"hide_from_guests": false
},
"required": [
"id",
"name",
"type",
"type_config",
"date_created",
"hide_from_guests",
"required"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"type_config": {
"type": "object"
},
"date_created": {
"type": "string"
},
"hide_from_guests": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "be43f58e-989e-4233-9f25-27584f094b74X",
"name": "Location type Custom Field",
"type": "location",
"required": false,
"type_config": {},
"date_created": "1617765143523",
"hide_from_guests": false
}
]
}
CustomFieldsRemoveFieldValueResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
CustomFieldsSetFieldValueResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
CustomItem
{
"type": "object",
"title": "Custom Item",
"example": {
"id": 1300,
"name": "Bug",
"description": "Custom task type for bugs.",
"name_plural": "Bugs"
},
"properties": {
"id": {
"type": "integer",
"description": "Custom task type ID.",
"contentEncoding": "int32"
},
"name": {
"type": "string",
"description": "Custom task type name."
},
"description": {
"type": "string",
"description": "Custom task type description."
},
"name_plural": {
"type": "string",
"description": "Custom task type plural name."
}
},
"x-examples": [
{
"id": 1300,
"name": "Bug",
"description": "Custom task type for bugs.",
"name_plural": "Bugs"
}
]
}
CustomItems
{
"type": "object",
"title": "CustomItems",
"example": {
"enabled": false
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": false
}
]
}
CustomRole
{
"type": "object",
"title": "CustomRole",
"example": {
"id": 12345,
"name": "guest custom"
},
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"name": {
"type": "string"
}
},
"x-examples": [
{
"id": 12345,
"name": "guest custom"
}
]
}
CustomRole2
{
"type": "object",
"title": "CustomRole2",
"example": {
"id": 4547089,
"name": "guest custom",
"members": [
12345,
67899
],
"team_id": "301539",
"date_created": "1651189835671",
"inherited_role": 4
},
"required": [
"id",
"team_id",
"name",
"inherited_role",
"date_created",
"members"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"name": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"team_id": {
"type": "string"
},
"date_created": {
"type": "string"
},
"inherited_role": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": 4547089,
"name": "guest custom",
"members": [
12345,
67899
],
"team_id": "301539",
"date_created": "1651189835671",
"inherited_role": 4
}
]
}
Data
{
"type": "object",
"title": "Data",
"example": {
"at": "1595293042560",
"id": "timer_idX",
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "task_name",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
}
},
"user": {
"id": 300528,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595293042560",
"billable": false,
"duration": -25655,
"description": ""
},
"required": [
"id",
"task",
"wid",
"user",
"billable",
"start",
"duration",
"description",
"tags",
"at"
],
"properties": {
"at": {
"type": "string"
},
"id": {
"type": "string"
},
"wid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"task": {
"$ref": "#/components/schemas/Task5"
},
"user": {
"$ref": "#/components/schemas/User2"
},
"start": {
"type": "string"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
},
"description": {
"type": "string"
}
},
"x-examples": [
{
"at": "1595293042560",
"id": "timer_idX",
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "task_name",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
}
},
"user": {
"id": 300528,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595293042560",
"billable": false,
"duration": -25655,
"description": ""
}
]
}
Data1
{
"type": "object",
"title": "Data1",
"example": {
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF",
"creator": 1
},
"required": [
"name",
"creator",
"tag_bg",
"tag_fg"
],
"properties": {
"name": {
"type": "string"
},
"tag_bg": {
"type": "string"
},
"tag_fg": {
"type": "string"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF",
"creator": 1
}
]
}
Data2
{
"type": "object",
"title": "Data2",
"example": {
"at": 1595289452790,
"id": "timer_idX",
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595289395842",
"billable": false,
"duration": -53,
"description": ""
},
"required": [
"id",
"task",
"wid",
"user",
"billable",
"start",
"duration",
"description",
"tags",
"at"
],
"properties": {
"at": {
"type": "integer",
"contentEncoding": "int64"
},
"id": {
"type": "string"
},
"wid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"task": {
"$ref": "#/components/schemas/Task6"
},
"user": {
"$ref": "#/components/schemas/User2"
},
"start": {
"type": "string"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
},
"description": {
"type": "string"
}
},
"x-examples": [
{
"at": 1595289452790,
"id": "timer_idX",
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595289395842",
"billable": false,
"duration": -53,
"description": ""
}
]
}
Data3
{
"type": "object",
"title": "Data3",
"example": {
"at": 1595289452790,
"id": "timer_idX",
"end": 1595289452790,
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595289395842",
"source": "clickup",
"billable": false,
"duration": 56948,
"description": ""
},
"required": [
"id",
"task",
"wid",
"user",
"billable",
"start",
"end",
"duration",
"description",
"tags",
"source",
"at"
],
"properties": {
"at": {
"type": "integer",
"contentEncoding": "int64"
},
"id": {
"type": "string"
},
"end": {
"type": "integer",
"contentEncoding": "int64"
},
"wid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"task": {
"$ref": "#/components/schemas/Task6"
},
"user": {
"$ref": "#/components/schemas/User2"
},
"start": {
"type": "string"
},
"source": {
"type": "string"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
},
"description": {
"type": "string"
}
},
"x-examples": [
{
"at": 1595289452790,
"id": "timer_idX",
"end": 1595289452790,
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595289395842",
"source": "clickup",
"billable": false,
"duration": 56948,
"description": ""
}
]
}
Datum
{
"type": "object",
"title": "Datum",
"example": {
"time": 1000000,
"user": {
"id": 1,
"color": "#795548",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": null
},
"intervals": [
{
"id": "318X",
"end": null,
"time": "1000000",
"start": null,
"source": "chrome",
"date_added": "1569983937761"
}
]
},
"required": [
"user",
"time",
"intervals"
],
"properties": {
"time": {
"type": "integer",
"contentEncoding": "int32"
},
"user": {
"$ref": "#/components/schemas/User13"
},
"intervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interval"
},
"description": ""
}
},
"x-examples": [
{
"time": 1000000,
"user": {
"id": 1,
"color": "#795548",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": null
},
"intervals": [
{
"id": "318X",
"end": null,
"time": "1000000",
"start": null,
"source": "chrome",
"date_added": "1569983937761"
}
]
}
]
}
Datum1
{
"type": "object",
"title": "Datum1",
"example": {
"at": "1592845899021",
"id": "1963465985517105840X",
"end": "1592845899021",
"wid": "300702",
"tags": [],
"task": {
"id": "1vwwavvX",
"name": "woof",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "open yes",
"orderindex": 0
},
"custom_id": "JOSH-917",
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1592841559129",
"source": "clickup",
"billable": false,
"duration": "4339892",
"task_url": "https://staging.clickup.com/t/1vwwavv",
"task_tags": [
{
"name": "content-request",
"tag_bg": "#2ecd6f",
"tag_fg": "#800000",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_bg": "#7C4DFF",
"tag_fg": "#800000",
"creator": 301828
}
],
"description": "",
"task_location": {
"list_id": 1560300071,
"space_id": 22800253,
"folder_id": 468300080,
"list_name": "List",
"space_name": "Space",
"folder_name": "Folder"
}
},
"required": [
"id",
"task",
"wid",
"user",
"billable",
"start",
"end",
"duration",
"description",
"tags",
"source",
"at",
"task_location",
"task_tags",
"task_url"
],
"properties": {
"at": {
"type": "string"
},
"id": {
"type": "string"
},
"end": {
"type": "string"
},
"wid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"task": {
"$ref": "#/components/schemas/Task4"
},
"user": {
"$ref": "#/components/schemas/User2"
},
"start": {
"type": "string"
},
"source": {
"type": "string"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "string"
},
"task_url": {
"type": "string"
},
"task_tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskTag"
},
"description": ""
},
"description": {
"type": "string"
},
"task_location": {
"$ref": "#/components/schemas/TaskLocation"
}
},
"x-examples": [
{
"at": "1592845899021",
"id": "1963465985517105840X",
"end": "1592845899021",
"wid": "300702",
"tags": [],
"task": {
"id": "1vwwavvX",
"name": "woof",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "open yes",
"orderindex": 0
},
"custom_id": "JOSH-917",
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1592841559129",
"source": "clickup",
"billable": false,
"duration": "4339892",
"task_url": "https://staging.clickup.com/t/1vwwavv",
"task_tags": [
{
"name": "content-request",
"tag_bg": "#2ecd6f",
"tag_fg": "#800000",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_bg": "#7C4DFF",
"tag_fg": "#800000",
"creator": 301828
}
],
"description": "",
"task_location": {
"list_id": 1560300071,
"space_id": 22800253,
"folder_id": 468300080,
"list_name": "List",
"space_name": "Space",
"folder_name": "Folder"
}
}
]
}
Datum2
{
"type": "object",
"title": "Datum2",
"example": {
"at": "1592845899021",
"id": "timer_idX",
"end": "1592845899021",
"wid": "workspace_id",
"tags": [],
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1592841559129",
"source": "clickup",
"billable": false,
"duration": "4339892",
"task_url": "https://staging.clickup.com/t/rnmuwz7",
"task_tags": [
{
"name": "content-request",
"tag_bg": "#2ecd6f",
"tag_fg": "#800000",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_bg": "#7C4DFF",
"tag_fg": "#800000",
"creator": 301828
}
],
"description": "",
"task_location": {
"list_id": 1560300071,
"space_id": 22800253,
"folder_id": 468300080,
"list_name": "List",
"space_name": "Space",
"folder_name": "Folder"
}
},
"required": [
"id",
"wid",
"user",
"billable",
"start",
"end",
"duration",
"description",
"tags",
"source",
"at",
"task_location",
"task_tags",
"task_url"
],
"properties": {
"at": {
"type": "string"
},
"id": {
"type": "string"
},
"end": {
"type": "string"
},
"wid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"user": {
"$ref": "#/components/schemas/User2"
},
"start": {
"type": "string"
},
"source": {
"type": "string"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "string"
},
"task_url": {
"type": "string"
},
"task_tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskTag"
},
"description": ""
},
"description": {
"type": "string"
},
"task_location": {
"$ref": "#/components/schemas/TaskLocation"
}
},
"x-examples": [
{
"at": "1592845899021",
"id": "timer_idX",
"end": "1592845899021",
"wid": "workspace_id",
"tags": [],
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1592841559129",
"source": "clickup",
"billable": false,
"duration": "4339892",
"task_url": "https://staging.clickup.com/t/rnmuwz7",
"task_tags": [
{
"name": "content-request",
"tag_bg": "#2ecd6f",
"tag_fg": "#800000",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_bg": "#7C4DFF",
"tag_fg": "#800000",
"creator": 301828
}
],
"description": "",
"task_location": {
"list_id": 1560300071,
"space_id": 22800253,
"folder_id": 468300080,
"list_name": "List",
"space_name": "Space",
"folder_name": "Folder"
}
}
]
}
DeleteSpaceTagrequest
{
"type": "object",
"title": "DeleteSpaceTagrequest",
"example": {
"tag": {
"name": "Tag name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
},
"required": [
"tag"
],
"properties": {
"tag": {
"$ref": "#/components/schemas/Tag"
}
},
"x-examples": [
{
"tag": {
"name": "Tag name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
}
]
}
DeleteTaskLinkresponse
{
"type": "object",
"title": "DeleteTaskLinkresponse",
"example": {
"task": {
"id": "9hvX",
"url": "https://app.clickup.com/t/9hx",
"list": {
"id": "123X"
},
"name": "Task Name",
"tags": [],
"space": {
"id": "789X"
},
"folder": {
"id": "456X"
},
"parent": null,
"status": {
"type": "custom",
"color": "#d3d3d3",
"status": "in progress",
"orderindex": 1
},
"creator": {
"id": 183,
"color": "#827718",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"due_date": null,
"priority": null,
"assignees": [],
"checklists": [],
"orderindex": "1.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"linked_tasks": [],
"time_estimate": null
}
},
"required": [
"task"
],
"properties": {
"task": {
"$ref": "#/components/schemas/Task1"
}
},
"x-examples": [
{
"task": {
"id": "9hvX",
"url": "https://app.clickup.com/t/9hx",
"list": {
"id": "123X"
},
"name": "Task Name",
"tags": [],
"space": {
"id": "789X"
},
"folder": {
"id": "456X"
},
"parent": null,
"status": {
"type": "custom",
"color": "#d3d3d3",
"status": "in progress",
"orderindex": 1
},
"creator": {
"id": 183,
"color": "#827718",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"due_date": null,
"priority": null,
"assignees": [],
"checklists": [],
"orderindex": "1.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"linked_tasks": [],
"time_estimate": null
}
}
]
}
DeleteatimeEntryresponse
{
"type": "object",
"title": "DeleteatimeEntryresponse",
"example": {
"data": {
"at": 1595289452790,
"id": "timer_idX",
"end": 1595289452790,
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595289395842",
"source": "clickup",
"billable": false,
"duration": 56948,
"description": ""
}
},
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Data3"
}
},
"x-examples": [
{
"data": {
"at": 1595289452790,
"id": "timer_idX",
"end": 1595289452790,
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595289395842",
"source": "clickup",
"billable": false,
"duration": 56948,
"description": ""
}
}
]
}
DependencyWarning
{
"type": "object",
"title": "DependencyWarning",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
Divide
{
"type": "object",
"title": "Divide",
"example": {
"dir": null,
"field": null,
"collapsed": []
},
"required": [
"collapsed"
],
"properties": {
"dir": {
"type": [
"null"
]
},
"field": {
"type": [
"null"
]
},
"collapsed": {
"type": [
"boolean"
]
}
},
"x-examples": [
{
"dir": null,
"field": null,
"collapsed": []
}
]
}
DueDates
{
"type": "object",
"title": "DueDates",
"example": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"required": [
"enabled",
"start_date",
"remap_due_dates",
"remap_closed_due_date"
],
"properties": {
"enabled": {
"type": "boolean"
},
"start_date": {
"type": "boolean"
},
"remap_due_dates": {
"type": "boolean"
},
"remap_closed_due_date": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
}
]
}
EditChecklistItemrequest
{
"type": "object",
"title": "EditChecklistItemrequest",
"example": {
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"resolved": true
},
"properties": {
"name": {
"type": "string"
},
"parent": {
"type": [
"string",
"null"
],
"description": "To nest a checklist item under another checklist item, include the other item's `checklist_item_id`."
},
"assignee": {
"type": [
"string",
"null"
]
},
"resolved": {
"type": "boolean"
}
},
"x-examples": [
{
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"resolved": true
}
]
}