Status
{
"type": "object",
"title": "Status",
"example": {
"type": "custom",
"color": "#d3d3d3",
"status": "in progress",
"orderindex": 1
},
"required": [
"status",
"color",
"orderindex",
"type"
],
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"status": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"type": "custom",
"color": "#d3d3d3",
"status": "in progress",
"orderindex": 1
}
]
}
Status11
{
"type": "object",
"title": "Status11",
"example": {
"color": "#e50000",
"status": "red",
"hide_label": true
},
"properties": {
"color": {
"type": "string"
},
"status": {
"type": "string"
},
"hide_label": {
"type": "boolean"
}
},
"x-examples": [
{
"color": "#e50000",
"status": "red",
"hide_label": true
}
]
}
Status15
{
"type": "object",
"title": "Status15",
"example": {
"id": "p16911531_p8y2WNC6X",
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"required": [
"id",
"status",
"type",
"orderindex",
"color"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"status": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": "p16911531_p8y2WNC6X",
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
}
]
}
Status5
{
"type": "object",
"title": "Status5",
"example": {
"color": "#e50000",
"status": "red",
"hide_label": true
},
"required": [
"status",
"color",
"hide_label"
],
"properties": {
"color": {
"type": "string"
},
"status": {
"type": "string"
},
"hide_label": {
"type": "boolean"
}
},
"x-examples": [
{
"color": "#e50000",
"status": "red",
"hide_label": true
}
]
}
StatusHistory
{
"type": "object",
"title": "StatusHistory",
"example": {
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21707
}
},
"required": [
"status",
"color",
"type",
"total_time",
"orderindex"
],
"properties": {
"type": {
"type": "string"
},
"color": {
"type": "string"
},
"status": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"total_time": {
"$ref": "#/components/schemas/TotalTime"
}
},
"x-examples": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21707
}
}
]
}
StopatimeEntryresponse
{
"type": "object",
"title": "StopatimeEntryresponse",
"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": ""
}
}
]
}
Tag
{
"type": "object",
"title": "Tag",
"example": {
"name": "Tag Name",
"tag_bg": "#000000",
"tag_fg": "#000000"
},
"required": [
"name",
"tag_fg",
"tag_bg"
],
"properties": {
"name": {
"type": "string"
},
"tag_bg": {
"type": "string"
},
"tag_fg": {
"type": "string"
}
},
"x-examples": [
{
"name": "Tag Name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
]
}
Tag1
{
"type": "object",
"title": "Tag1",
"example": {
"name": "Updated Tag",
"bg_color": "#ffffff",
"fg_color": "#ffffff"
},
"required": [
"name",
"fg_color",
"bg_color"
],
"properties": {
"name": {
"type": "string"
},
"bg_color": {
"type": "string"
},
"fg_color": {
"type": "string"
}
},
"x-examples": [
{
"name": "Updated Tag",
"bg_color": "#ffffff",
"fg_color": "#ffffff"
}
]
}
Tags
{
"type": "object",
"title": "Tags",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
Tags10
{
"type": "object",
"title": "Tags10",
"example": {
"name": "name of tag"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
},
"x-examples": [
{
"name": "name of tag"
}
]
}
Tags6
{
"type": "object",
"title": "Tags6",
"example": {
"name": "Tag name",
"tag_bg": "#000000",
"tag_fg": "#000000"
},
"required": [
"name",
"tag_fg",
"tag_bg"
],
"properties": {
"name": {
"type": "string"
},
"tag_bg": {
"type": "string"
},
"tag_fg": {
"type": "string"
}
},
"x-examples": [
{
"name": "Tag name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
]
}
TagsAddToTaskResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TagsCreateSpaceTagResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TagsRemoveFromTaskResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TagsRemoveSpaceTagResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
Task
{
"type": "object",
"title": "Task",
"example": {
"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": [
{
"userid": "183",
"link_id": "9hz",
"task_id": "9hv",
"date_created": "1587571108988"
}
],
"time_estimate": null
},
"required": [
"id",
"name",
"status",
"orderindex",
"date_created",
"date_updated",
"date_closed",
"creator",
"assignees",
"checklists",
"tags",
"parent",
"priority",
"due_date",
"start_date",
"time_estimate",
"time_spent",
"list",
"folder",
"space",
"linked_tasks",
"url"
],
"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": ""
},
"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"
]
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"linked_tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkedTask"
},
"description": ""
},
"time_estimate": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"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": [
{
"userid": "183",
"link_id": "9hz",
"task_id": "9hv",
"date_created": "1587571108988"
}
],
"time_estimate": null
}
]
}
Task1
{
"type": "object",
"title": "Task1",
"example": {
"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": [
"id",
"name",
"status",
"orderindex",
"date_created",
"date_updated",
"date_closed",
"creator",
"assignees",
"checklists",
"tags",
"parent",
"priority",
"due_date",
"start_date",
"time_estimate",
"time_spent",
"list",
"folder",
"space",
"linked_tasks",
"url"
],
"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": ""
},
"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"
]
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"linked_tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"time_estimate": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"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
}
]
}
Task2
{
"type": "object",
"title": "Task2",
"example": {
"id": "c04X",
"url": "https://app.clickup.com/t/c04",
"list": {
"id": "1752X",
"name": "Shared with me",
"access": false
},
"name": "Task Name",
"tags": [],
"space": {
"id": "380X"
},
"folder": {
"id": "1217X",
"name": "Shared with me",
"access": false,
"hidden": false
},
"parent": null,
"points": null,
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
"creator": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"team_id": "108",
"archived": false,
"due_date": "1508369194377",
"priority": {
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
},
"assignees": [],
"checklists": [],
"orderindex": "0",
"start_date": null,
"date_closed": null,
"date_created": "1574718405408",
"date_updated": "1574722145869",
"dependencies": [],
"custom_fields": [],
"time_estimate": null,
"permission_level": "read"
},
"required": [
"id",
"name",
"status",
"orderindex",
"date_created",
"date_updated",
"date_closed",
"archived",
"creator",
"assignees",
"checklists",
"tags",
"parent",
"priority",
"due_date",
"start_date",
"points",
"time_estimate",
"custom_fields",
"dependencies",
"team_id",
"url",
"permission_level",
"list",
"folder",
"space"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"list": {
"$ref": "#/components/schemas/List2"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"space": {
"$ref": "#/components/schemas/Space"
},
"folder": {
"$ref": "#/components/schemas/Folder3"
},
"parent": {
"type": [
"string",
"null"
]
},
"points": {
"type": [
"string",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Status"
},
"creator": {
"$ref": "#/components/schemas/Creator"
},
"team_id": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"due_date": {
"type": "string"
},
"priority": {
"$ref": "#/components/schemas/Priority"
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"orderindex": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"date_closed": {
"type": [
"string",
"null"
]
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"dependencies": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"custom_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"permission_level": {
"type": "string"
}
},
"x-examples": [
{
"id": "c04X",
"url": "https://app.clickup.com/t/c04",
"list": {
"id": "1752X",
"name": "Shared with me",
"access": false
},
"name": "Task Name",
"tags": [],
"space": {
"id": "380X"
},
"folder": {
"id": "1217X",
"name": "Shared with me",
"access": false,
"hidden": false
},
"parent": null,
"points": null,
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
"creator": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"team_id": "108",
"archived": false,
"due_date": "1508369194377",
"priority": {
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
},
"assignees": [],
"checklists": [],
"orderindex": "0",
"start_date": null,
"date_closed": null,
"date_created": "1574718405408",
"date_updated": "1574722145869",
"dependencies": [],
"custom_fields": [],
"time_estimate": null,
"permission_level": "read"
}
]
}
Task3
{
"type": "object",
"title": "Task3",
"example": {
"id": "av1X",
"url": "https://app.clickup.com/t/av1",
"list": {
"id": "1X",
"name": "List",
"access": true
},
"name": "My First Task",
"tags": [
{
"name": "tagged",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
],
"space": {
"id": "1X"
},
"folder": {
"id": "1X",
"name": "Folder",
"access": true,
"hidden": false
},
"parent": "av2",
"points": 1.3,
"status": {
"type": "open",
"color": "#000000",
"status": "Open",
"orderindex": 1
},
"creator": {
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
},
"project": {
"id": "1X",
"name": "Folder",
"access": true,
"hidden": false
},
"team_id": "1234",
"due_date": "1508369194377",
"priority": 1,
"watchers": [
{
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"assignees": [
{
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"custom_id": null,
"checklists": [
{
"id": "d41340bc-2f17-43cc-ae71-86628f45825fX",
"name": "Checklist",
"items": [
{
"id": "9398cb3d-55a4-4c45-ab46-2a47a371e375X",
"name": "checklist item 1",
"parent": null,
"assignee": null,
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1618455810454"
}
],
"creator": 2770032,
"task_id": "3cxv9f",
"resolved": 0,
"orderindex": 1,
"unresolved": 1,
"date_created": "1618455803730"
}
],
"orderindex": "1.0000",
"start_date": "1508369194377",
"date_closed": "1508369194377",
"description": "Task description",
"date_created": "1508369194377",
"date_updated": "1508369194377",
"dependencies": [],
"linked_tasks": [],
"text_content": "Task description",
"custom_fields": [
{
"id": "be43f58e-989e-4233-9f25-27584f094b74X",
"name": "Location type Custom Field",
"type": "location",
"required": false,
"type_config": {},
"date_created": "1617765143523",
"hide_from_guests": false
}
],
"time_estimate": 1.2,
"permission_level": "create",
"markdown_description": "Task description"
},
"required": [
"id",
"custom_id",
"name",
"text_content",
"description",
"status",
"orderindex",
"date_created",
"date_updated",
"date_closed",
"date_done",
"creator",
"assignees",
"watchers",
"checklists",
"tags",
"parent",
"priority",
"due_date",
"start_date",
"points",
"time_estimate",
"custom_fields",
"dependencies",
"linked_tasks",
"team_id",
"url",
"permission_level",
"list",
"project",
"folder",
"space"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"list": {
"$ref": "#/components/schemas/List2"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags6"
},
"description": ""
},
"space": {
"$ref": "#/components/schemas/Space"
},
"folder": {
"$ref": "#/components/schemas/Folder3"
},
"parent": {
"type": "string"
},
"points": {
"type": "number"
},
"status": {
"$ref": "#/components/schemas/Status"
},
"creator": {
"$ref": "#/components/schemas/Creator5"
},
"project": {
"$ref": "#/components/schemas/Project"
},
"team_id": {
"type": "string"
},
"due_date": {
"type": "string"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"watchers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Watchers1"
},
"description": ""
},
"assignees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Assignees1"
},
"description": ""
},
"custom_id": {
"type": [
"string",
"null"
]
},
"date_done": {
"type": [
"string",
"null"
]
},
"checklists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Checklists6"
},
"description": ""
},
"orderindex": {
"type": "string"
},
"start_date": {
"type": "string"
},
"date_closed": {
"type": "string"
},
"description": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"dependencies": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"linked_tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"text_content": {
"type": "string"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFields9"
},
"description": ""
},
"time_estimate": {
"type": "number"
},
"permission_level": {
"type": "string"
},
"markdown_description": {
"type": "string"
}
},
"x-examples": [
{
"id": "av1X",
"url": "https://app.clickup.com/t/av1",
"list": {
"id": "1X",
"name": "List",
"access": true
},
"name": "My First Task",
"tags": [
{
"name": "tagged",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
],
"space": {
"id": "1X"
},
"folder": {
"id": "1X",
"name": "Folder",
"access": true,
"hidden": false
},
"parent": "av2",
"points": 1.3,
"status": {
"type": "open",
"color": "#000000",
"status": "Open",
"orderindex": 1
},
"creator": {
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
},
"project": {
"id": "1X",
"name": "Folder",
"access": true,
"hidden": false
},
"team_id": "1234",
"due_date": "1508369194377",
"priority": 1,
"watchers": [
{
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"assignees": [
{
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"custom_id": null,
"checklists": [
{
"id": "d41340bc-2f17-43cc-ae71-86628f45825fX",
"name": "Checklist",
"items": [
{
"id": "9398cb3d-55a4-4c45-ab46-2a47a371e375X",
"name": "checklist item 1",
"parent": null,
"assignee": null,
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1618455810454"
}
],
"creator": 2770032,
"task_id": "3cxv9f",
"resolved": 0,
"orderindex": 1,
"unresolved": 1,
"date_created": "1618455803730"
}
],
"orderindex": "1.0000",
"start_date": "1508369194377",
"date_closed": "1508369194377",
"description": "Task description",
"date_created": "1508369194377",
"date_updated": "1508369194377",
"dependencies": [],
"linked_tasks": [],
"text_content": "Task description",
"custom_fields": [
{
"id": "be43f58e-989e-4233-9f25-27584f094b74X",
"name": "Location type Custom Field",
"type": "location",
"required": false,
"type_config": {},
"date_created": "1617765143523",
"hide_from_guests": false
}
],
"time_estimate": 1.2,
"permission_level": "create",
"markdown_description": "Task description"
}
]
}
Task4
{
"type": "object",
"title": "Task4",
"example": {
"id": "1vwwavvX",
"name": "woof",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "open yes",
"orderindex": 0
},
"custom_id": "JOSH-917",
"custom_type": null
},
"required": [
"id",
"custom_id",
"name",
"status",
"custom_type"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Status"
},
"custom_id": {
"type": "string"
},
"custom_type": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": "1vwwavvX",
"name": "woof",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "open yes",
"orderindex": 0
},
"custom_id": "JOSH-917",
"custom_type": null
}
]
}
Task5
{
"type": "object",
"title": "Task5",
"example": {
"id": "task_idX",
"name": "task_name",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
}
},
"required": [
"id",
"name",
"status"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Status"
}
},
"x-examples": [
{
"id": "task_idX",
"name": "task_name",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
}
}
]
}
Task6
{
"type": "object",
"title": "Task6",
"example": {
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
},
"required": [
"id",
"name",
"status",
"custom_type"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Status"
},
"custom_type": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
}
]
}
Task9
{
"type": "object",
"title": "Task9",
"example": {
"id": "9hxX",
"url": "https://app.clickup.com/t/9hx",
"list": {
"id": "123X"
},
"name": "New Task Name",
"tags": [],
"space": {
"id": "789X"
},
"folder": {
"id": "456X"
},
"parent": null,
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
"creator": {
"id": 183,
"color": "#827718",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"due_date": null,
"priority": null,
"watchers": [],
"assignees": [],
"date_done": null,
"checklists": [],
"orderindex": "1.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"time_estimate": null,
"custom_item_id": null,
"markdown_description": "Task description"
},
"required": [
"id",
"custom_item_id",
"name",
"status",
"orderindex",
"date_created",
"date_updated",
"date_closed",
"date_done",
"creator",
"assignees",
"watchers",
"checklists",
"tags",
"parent",
"priority",
"due_date",
"start_date",
"time_estimate",
"time_spent",
"list",
"folder",
"space",
"url"
],
"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"
]
},
"watchers": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"date_done": {
"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"
]
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"custom_item_id": {
"type": [
"number",
"null"
]
},
"markdown_description": {
"type": "string"
}
},
"x-examples": [
{
"id": "9hxX",
"url": "https://app.clickup.com/t/9hx",
"list": {
"id": "123X"
},
"name": "New Task Name",
"tags": [],
"space": {
"id": "789X"
},
"folder": {
"id": "456X"
},
"parent": null,
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
"creator": {
"id": 183,
"color": "#827718",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"due_date": null,
"priority": null,
"watchers": [],
"assignees": [],
"date_done": null,
"checklists": [],
"orderindex": "1.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"time_estimate": null,
"custom_item_id": null,
"markdown_description": "Task description"
}
]
}
TaskChecklistsRemoveChecklistItemResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TaskChecklistsRemoveChecklistResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TaskChecklistsUpdateChecklistResponse
{
"type": "object",
"contentMediaType": "application/json"
}
TaskLocation
{
"type": "object",
"title": "TaskLocation",
"example": {
"list_id": 1560300071,
"space_id": 22800253,
"folder_id": 468300080,
"list_name": "List",
"space_name": "Space",
"folder_name": "Folder"
},
"required": [
"list_id",
"folder_id",
"space_id",
"list_name",
"folder_name",
"space_name"
],
"properties": {
"list_id": {
"type": "integer",
"contentEncoding": "int32"
},
"space_id": {
"type": "integer",
"contentEncoding": "int32"
},
"folder_id": {
"type": "integer",
"contentEncoding": "int32"
},
"list_name": {
"type": "string"
},
"space_name": {
"type": "string"
},
"folder_name": {
"type": "string"
}
},
"x-examples": [
{
"list_id": 1560300071,
"space_id": 22800253,
"folder_id": 468300080,
"list_name": "List",
"space_name": "Space",
"folder_name": "Folder"
}
]
}
TaskRelationshipsAddDependencyResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TaskRelationshipsRemoveDependencyResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TaskTag
{
"type": "object",
"title": "TaskTag",
"example": {
"name": "content-request",
"tag_bg": "#2ecd6f",
"tag_fg": "#800000",
"creator": 301828
},
"required": [
"name",
"tag_fg",
"tag_bg",
"creator"
],
"properties": {
"name": {
"type": "string"
},
"tag_bg": {
"type": "string"
},
"tag_fg": {
"type": "string"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"name": "content-request",
"tag_bg": "#2ecd6f",
"tag_fg": "#800000",
"creator": 301828
}
]
}
TaskTemplatesCreateFromTemplateResponse
{
"type": "object",
"contentMediaType": "application/json"
}
TasksRemoveTaskByIdResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
Team
{
"type": "object",
"title": "Team",
"example": {
"id": "1234X",
"name": "My ClickUp Workspace",
"color": "#000000",
"avatar": "https://clickup.com/avatar.jpg",
"members": [
{
"user": {
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
}
]
},
"required": [
"id",
"name",
"color",
"avatar",
"members"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"avatar": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
},
"description": ""
}
},
"x-examples": [
{
"id": "1234X",
"name": "My ClickUp Workspace",
"color": "#000000",
"avatar": "https://clickup.com/avatar.jpg",
"members": [
{
"user": {
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
}
]
}
]
}
Team1
{
"type": "object",
"title": "Team1",
"example": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"custom": true,
"inherited_role": 3
},
{
"id": 112233,
"name": "admin custom",
"custom": true,
"inherited_role": 2
},
{
"id": 12345,
"name": "guest custom",
"custom": true,
"inherited_role": 4
}
],
"avatar": null,
"members": [
{
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_create_views": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
]
},
"required": [
"id",
"name",
"color",
"avatar",
"members",
"roles"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
},
"description": ""
},
"avatar": {
"type": [
"string",
"null"
]
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member4"
},
"description": ""
}
},
"x-examples": [
{
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"custom": true,
"inherited_role": 3
},
{
"id": 112233,
"name": "admin custom",
"custom": true,
"inherited_role": 2
},
{
"id": 12345,
"name": "guest custom",
"custom": true,
"inherited_role": 4
}
],
"avatar": null,
"members": [
{
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_create_views": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
]
}
]
}
Team2
{
"type": "object",
"title": "Team2",
"example": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
},
"required": [
"id",
"name",
"color",
"avatar",
"members"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"avatar": {
"type": [
"string",
"null"
]
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
]
}
Team3
{
"type": "object",
"title": "Team3",
"example": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"custom": true,
"inherited_role": 3
},
{
"id": 112233,
"name": "admin custom",
"custom": true,
"inherited_role": 2
},
{
"id": 12345,
"name": "guest custom",
"custom": true,
"inherited_role": 4
}
],
"avatar": null,
"members": [
{
"user": {
"id": 184,
"role": 2,
"color": null,
"email": "user@example.com",
"initials": "G",
"username": null,
"custom_role": {
"id": 112233,
"name": "admin custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
}
]
},
"required": [
"id",
"name",
"color",
"avatar",
"members",
"roles"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
},
"description": ""
},
"avatar": {
"type": [
"string",
"null"
]
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Members5"
},
"description": ""
}
},
"x-examples": [
{
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"custom": true,
"inherited_role": 3
},
{
"id": 112233,
"name": "admin custom",
"custom": true,
"inherited_role": 2
},
{
"id": 12345,
"name": "guest custom",
"custom": true,
"inherited_role": 4
}
],
"avatar": null,
"members": [
{
"user": {
"id": 184,
"role": 2,
"color": null,
"email": "user@example.com",
"initials": "G",
"username": null,
"custom_role": {
"id": 112233,
"name": "admin custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
}
]
}
]
}
TeamSidebar
{
"type": "object",
"title": "TeamSidebar",
"example": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
},
"required": [
"assignees",
"assigned_comments",
"unassigned_tasks"
],
"properties": {
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"unassigned_tasks": {
"type": "boolean"
},
"assigned_comments": {
"type": "boolean"
}
},
"x-examples": [
{
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
]
}
TeamsUserGroupsRemoveGroupResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TimeEstimates
{
"type": "object",
"title": "TimeEstimates",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
TimeTracking
{
"type": "object",
"title": "TimeTracking",
"example": {
"enabled": false
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": false
}
]
}
TimeTrackingAddTagsFromTimeEntriesResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TimeTrackingChangeTagNamesResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TimeTrackingGetTimeEntryHistoryResponse
{
"type": "object",
"contentMediaType": "application/json"
}
TimeTrackingLegacyEditTimeTrackedResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TimeTrackingLegacyRemoveTrackedTimeResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TimeTrackingRemoveTagsFromTimeEntriesResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
TimeTrackingUpdateTimeEntryDetailsResponse
{
"type": "object",
"contentMediaType": "application/json"
}
TotalTime
{
"type": "object",
"title": "TotalTime",
"example": {
"since": "1604004423494",
"by_minute": 21708
},
"required": [
"by_minute",
"since"
],
"properties": {
"since": {
"type": "string"
},
"by_minute": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"since": "1604004423494",
"by_minute": 21708
}
]
}
Tracking
{
"type": "object",
"title": "Tracking",
"example": {
"subtasks": true,
"checklists": true,
"assigned_comments": true
},
"required": [
"subtasks",
"checklists",
"assigned_comments"
],
"properties": {
"subtasks": {
"type": "boolean"
},
"checklists": {
"type": "boolean"
},
"assigned_comments": {
"type": "boolean"
}
},
"x-examples": [
{
"subtasks": true,
"checklists": true,
"assigned_comments": true
}
]
}
Tracktimerequest
{
"type": "object",
"title": "Tracktimerequest",
"example": {
"end": 1508369194377,
"time": 8640000,
"start": 1567780450202
},
"required": [
"start",
"end",
"time"
],
"properties": {
"end": {
"type": "integer",
"contentEncoding": "int64"
},
"time": {
"type": "integer",
"contentEncoding": "int32"
},
"start": {
"type": "integer",
"contentEncoding": "int64"
}
},
"x-examples": [
{
"end": 1508369194377,
"time": 8640000,
"start": 1567780450202
}
]
}