Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.clickup.com/api/v2
https://a00fb6e0-339c-4201-972f-503b9932d17a.remockly.com
No endpoints found for this provider.
20bbn28
{
"type": "object",
"title": "20bbn28",
"example": {
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004420925",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004420925",
"by_minute": 22276
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1601597828835",
"by_minute": 40109
}
}
]
},
"required": [
"current_status",
"status_history"
],
"properties": {
"current_status": {
"$ref": "#/components/schemas/CurrentStatus"
},
"status_history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusHistory"
},
"description": ""
}
},
"x-examples": [
{
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004420925",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004420925",
"by_minute": 22276
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1601597828835",
"by_minute": 40109
}
}
]
}
]
}
27075wz
{
"type": "object",
"title": "27075wz",
"example": {
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21829
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1602607941692",
"by_minute": 23274
}
}
]
},
"required": [
"current_status",
"status_history"
],
"properties": {
"current_status": {
"$ref": "#/components/schemas/CurrentStatus"
},
"status_history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusHistory"
},
"description": ""
}
},
"x-examples": [
{
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21829
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1602607941692",
"by_minute": 23274
}
}
]
}
]
}
AddDependencyrequest
{
"type": "object",
"title": "AddDependencyrequest",
"example": {
"depends_on": "9hw"
},
"properties": {
"depends_on": {
"type": "string"
},
"depedency_of": {
"type": "string"
}
},
"x-examples": [
{
"depends_on": "9hw"
}
]
}
AddGuestToFolderrequest
{
"type": "object",
"title": "AddGuestToFolderrequest",
"example": {
"permission_level": "read"
},
"required": [
"permission_level"
],
"properties": {
"permission_level": {
"type": "string",
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
}
},
"x-examples": [
{
"permission_level": "read"
}
]
}
AddGuestToFolderresponse
{
"type": "object",
"title": "AddGuestToFolderresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest5"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
AddGuestToListrequest
{
"type": "object",
"title": "AddGuestToListrequest",
"example": {
"permission_level": "read"
},
"required": [
"permission_level"
],
"properties": {
"permission_level": {
"type": "string",
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
}
},
"x-examples": [
{
"permission_level": "read"
}
]
}
AddGuestToListresponse
{
"type": "object",
"title": "AddGuestToListresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest3"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
AddGuestToTaskrequest
{
"type": "object",
"title": "AddGuestToTaskrequest",
"example": {
"permission_level": "read"
},
"required": [
"permission_level"
],
"properties": {
"permission_level": {
"type": "string",
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
}
},
"x-examples": [
{
"permission_level": "read"
}
]
}
AddGuestToTaskresponse
{
"type": "object",
"title": "AddGuestToTaskresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [
{
"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"
}
],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest1"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [
{
"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"
}
],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
AddTaskLinkresponse
{
"type": "object",
"title": "AddTaskLinkresponse",
"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": [
{
"userid": "183",
"link_id": "9hz",
"task_id": "9hv",
"date_created": "1587571108988"
}
],
"time_estimate": null
}
},
"required": [
"task"
],
"properties": {
"task": {
"$ref": "#/components/schemas/Task"
}
},
"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": [
{
"userid": "183",
"link_id": "9hz",
"task_id": "9hv",
"date_created": "1587571108988"
}
],
"time_estimate": null
}
}
]
}
Addtagsfromtimeentriesrequest
{
"type": "object",
"title": "Addtagsfromtimeentriesrequest",
"example": {
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"time_entry_ids": [
"timer_id"
]
},
"required": [
"time_entry_ids",
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags6"
},
"description": ""
},
"time_entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"time_entry_ids": [
"timer_id"
]
}
]
}
AssignedBy
{
"type": "object",
"title": "AssignedBy",
"example": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"required": [
"id",
"username",
"initials",
"email",
"color",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
}
Assignee
{
"type": "object",
"title": "Assignee",
"example": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
]
}
Assignee3
{
"type": "object",
"title": "Assignee3",
"example": {
"id": 183,
"color": "#827718",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"required": [
"id",
"color",
"username",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
]
}
Assignees
{
"type": "object",
"title": "Assignees",
"example": {
"add": [
182
],
"rem": [
183
]
},
"required": [
"add",
"rem"
],
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"rem": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"x-examples": [
{
"add": [
182
],
"rem": [
183
]
}
]
}
Assignees1
{
"type": "object",
"title": "Assignees1",
"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"
}
]
}
Attachment
{
"type": "object",
"title": "Attachment",
"example": {
"id": "62447c77-2086-4cda-b274-f53eccf0547b.csv",
"url": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"date": 1711570108374,
"size": 140970,
"type": 1,
"user": [
{
"id": [
{
"type": "integer",
"contentEncoding": "int32"
}
],
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
}
],
"title": "Canny - Exported posts - 2024-03-09.csv",
"hidden": false,
"source": 1,
"deleted": false,
"version": 0,
"mimetype": "text/csv",
"extension": "csv",
"is_folder": null,
"parent_id": "36fjfqy",
"email_data": null,
"url_w_host": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"orientation": null,
"url_w_query": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv?view=open",
"total_comments": 0,
"thumbnail_large": null,
"thumbnail_small": null,
"thumbnail_medium": null,
"resolved_comments": 0
},
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"date": {
"type": "bigint"
},
"size": {
"type": "bigint"
},
"type": {
"type": "int"
},
"user": {
"$ref": "#/components/schemas/User2",
"type": "string"
},
"title": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"source": {
"type": "int"
},
"deleted": {
"type": "boolean"
},
"version": {
"type": "int"
},
"mimetype": {
"type": "string"
},
"extension": {
"type": "string"
},
"is_folder": {
"type": "boolean"
},
"parent_id": {
"type": "string"
},
"email_data": {
"type": "object"
},
"url_w_host": {
"type": "string"
},
"orientation": {
"type": "string"
},
"url_w_query": {
"type": "string"
},
"total_comments": {
"type": "int"
},
"thumbnail_large": {
"type": "string"
},
"thumbnail_small": {
"type": "string"
},
"thumbnail_medium": {
"type": "string"
},
"resolved_comments": {
"type": "int"
}
},
"x-examples": [
{
"id": "62447c77-2086-4cda-b274-f53eccf0547b.csv",
"url": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"date": 1711570108374,
"size": 140970,
"type": 1,
"user": [
{
"id": [
{
"type": "integer",
"contentEncoding": "int32"
}
],
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
}
],
"title": "Canny - Exported posts - 2024-03-09.csv",
"hidden": false,
"source": 1,
"deleted": false,
"version": 0,
"mimetype": "text/csv",
"extension": "csv",
"is_folder": null,
"parent_id": "36fjfqy",
"email_data": null,
"url_w_host": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"orientation": null,
"url_w_query": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv?view=open",
"total_comments": 0,
"thumbnail_large": null,
"thumbnail_small": null,
"thumbnail_medium": null,
"resolved_comments": 0
}
]
}
AttachmentsUploadFileToTaskAsAttachmentRequest
{
"properties": {
"attachment": {
"type": "array",
"items": {}
}
}
}
Avatar
{
"type": "object",
"title": "Avatar",
"example": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"required": [
"attachment_id",
"color",
"source",
"icon"
],
"properties": {
"icon": {
"type": [
"string",
"null"
]
},
"color": {
"type": [
"string",
"null"
]
},
"source": {
"type": [
"string",
"null"
]
},
"attachment_id": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"icon": null,
"color": null,
"source": null,
"attachment_id": null
}
]
}
Changetagnamesfromtimeentriesrequest
{
"type": "object",
"title": "Changetagnamesfromtimeentriesrequest",
"example": {
"name": "old tag name",
"tag_bg": "#000000",
"tag_fg": "#000000",
"new_name": "new tag name"
},
"required": [
"name",
"new_name",
"tag_bg",
"tag_fg"
],
"properties": {
"name": {
"type": "string"
},
"tag_bg": {
"type": "string"
},
"tag_fg": {
"type": "string"
},
"new_name": {
"type": "string"
}
},
"x-examples": [
{
"name": "old tag name",
"tag_bg": "#000000",
"tag_fg": "#000000",
"new_name": "new tag name"
}
]
}
Checklist
{
"type": "object",
"title": "Checklist",
"example": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [],
"task_id": "9hz",
"resolved": 0,
"orderindex": 0,
"unresolved": 0
},
"required": [
"id",
"task_id",
"name",
"orderindex",
"resolved",
"unresolved",
"items"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"task_id": {
"type": "string"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [],
"task_id": "9hz",
"resolved": 0,
"orderindex": 0,
"unresolved": 0
}
]
}
Checklist1
{
"type": "object",
"title": "Checklist1",
"example": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 0,
"orderindex": 0,
"unresolved": 1,
"date_created": "1567711563204"
},
"required": [
"id",
"task_id",
"name",
"date_created",
"orderindex",
"resolved",
"unresolved",
"items"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
},
"description": ""
},
"task_id": {
"type": "string"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 0,
"orderindex": 0,
"unresolved": 1,
"date_created": "1567711563204"
}
]
}
Checklist2
{
"type": "object",
"title": "Checklist2",
"example": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"children": [],
"resolved": true,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 1,
"orderindex": 0,
"unresolved": 0,
"date_created": "1567711563204"
},
"required": [
"id",
"task_id",
"name",
"date_created",
"orderindex",
"resolved",
"unresolved",
"items"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item1"
},
"description": ""
},
"task_id": {
"type": "string"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"children": [],
"resolved": true,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 1,
"orderindex": 0,
"unresolved": 0,
"date_created": "1567711563204"
}
]
}
Checklists
{
"type": "object",
"title": "Checklists",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
Checklists6
{
"type": "object",
"title": "Checklists6",
"example": {
"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"
},
"required": [
"id",
"task_id",
"name",
"date_created",
"orderindex",
"creator",
"resolved",
"unresolved",
"items"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item1"
},
"description": ""
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"task_id": {
"type": "string"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"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"
}
]
}
Columns
{
"type": "object",
"title": "Columns",
"example": {
"fields": []
},
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom Fields require the `_cf` prefix and must be formatted as a JSON object."
}
},
"x-examples": [
{
"fields": []
}
],
"description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy."
}
Comment
{
"type": "object",
"title": "Comment",
"example": {
"id": "458X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "Task comment content"
}
],
"assignee": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"reactions": [],
"assigned_by": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment_text": "Task comment content"
},
"required": [
"id",
"comment",
"comment_text",
"user",
"resolved",
"assignee",
"assigned_by",
"reactions",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User2"
},
"comment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment1"
},
"description": ""
},
"assignee": {
"$ref": "#/components/schemas/Assignee"
},
"resolved": {
"type": "boolean"
},
"reactions": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"assigned_by": {
"$ref": "#/components/schemas/AssignedBy"
},
"comment_text": {
"type": "string"
}
},
"x-examples": [
{
"id": "458X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "Task comment content"
}
],
"assignee": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"reactions": [],
"assigned_by": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment_text": "Task comment content"
}
]
}
Comment1
{
"type": "object",
"title": "Comment1",
"example": {
"text": "Task comment content"
},
"required": [
"text"
],
"properties": {
"text": {
"type": "string"
}
},
"x-examples": [
{
"text": "Task comment content"
}
]
}
Comment2
{
"type": "object",
"title": "Comment2",
"example": {
"id": "459X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "View comment content"
}
],
"assignee": null,
"resolved": false,
"reactions": [],
"assigned_by": null,
"comment_text": "View comment content"
},
"required": [
"id",
"comment",
"comment_text",
"user",
"resolved",
"assignee",
"assigned_by",
"reactions",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User2"
},
"comment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment1"
},
"description": ""
},
"assignee": {
"type": [
"string",
"null"
]
},
"resolved": {
"type": "boolean"
},
"reactions": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"assigned_by": {
"type": [
"string",
"null"
]
},
"comment_text": {
"type": "string"
}
},
"x-examples": [
{
"id": "459X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "View comment content"
}
],
"assignee": null,
"resolved": false,
"reactions": [],
"assigned_by": null,
"comment_text": "View comment content"
}
]
}
CommentsDeleteTaskCommentResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
CommentsUpdateTaskCommentResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
CreateChatViewCommentrequest
{
"type": "object",
"title": "CreateChatViewCommentrequest",
"example": {
"notify_all": true,
"comment_text": "View comment content"
},
"required": [
"comment_text",
"notify_all"
],
"properties": {
"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": [
{
"notify_all": true,
"comment_text": "View comment content"
}
]
}
CreateChatViewCommentresponse
{
"type": "object",
"title": "CreateChatViewCommentresponse",
"example": {
"id": "459X",
"date": 1568037065216,
"hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae"
},
"required": [
"id",
"hist_id",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
},
"hist_id": {
"type": "string"
}
},
"x-examples": [
{
"id": "459X",
"date": 1568037065216,
"hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae"
}
]
}
CreateChecklistItemrequest
{
"type": "object",
"title": "CreateChecklistItemrequest",
"example": {
"name": "Checklist Item",
"assignee": 183
},
"properties": {
"name": {
"type": "string"
},
"assignee": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"name": "Checklist Item",
"assignee": 183
}
]
}
CreateChecklistItemresponse
{
"type": "object",
"title": "CreateChecklistItemresponse",
"example": {
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 0,
"orderindex": 0,
"unresolved": 1,
"date_created": "1567711563204"
}
},
"required": [
"checklist"
],
"properties": {
"checklist": {
"$ref": "#/components/schemas/Checklist1"
}
},
"x-examples": [
{
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 0,
"orderindex": 0,
"unresolved": 1,
"date_created": "1567711563204"
}
}
]
}
CreateChecklistrequest
{
"type": "object",
"title": "CreateChecklistrequest",
"example": {
"name": "Checklist"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
},
"x-examples": [
{
"name": "Checklist"
}
]
}
CreateChecklistresponse
{
"type": "object",
"title": "CreateChecklistresponse",
"example": {
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [],
"task_id": "9hz",
"resolved": 0,
"orderindex": 0,
"unresolved": 0
}
},
"required": [
"checklist"
],
"properties": {
"checklist": {
"$ref": "#/components/schemas/Checklist"
}
},
"x-examples": [
{
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [],
"task_id": "9hz",
"resolved": 0,
"orderindex": 0,
"unresolved": 0
}
}
]
}
CreateFolderViewrequest
{
"type": "object",
"title": "CreateFolderViewrequest",
"example": {
"name": "New Folder 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 Folder 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
}
}
]
}
CreateFolderViewresponse
{
"type": "object",
"title": "CreateFolderViewresponse",
"example": {
"view": {
"id": "3c-107X",
"name": "New Folder View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "457X",
"type": 5
},
"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-107X",
"name": "New Folder View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "457X",
"type": 5
},
"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
}
}
}
]
}
CreateFolderlessListrequest
{
"type": "object",
"title": "CreateFolderlessListrequest",
"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 add a List owner.",
"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
}
]
}
CreateFolderlessListresponse
{
"type": "object",
"title": "CreateFolderlessListresponse",
"example": {
"id": "124X",
"name": "New List Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"folder": {
"id": "457X",
"name": "hidden",
"access": true,
"hidden": true
},
"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": "457X",
"name": "hidden",
"access": true,
"hidden": true
},
"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
}
]
}
CreateFolderrequest
{
"type": "object",
"title": "CreateFolderrequest",
"example": {
"name": "New Folder Name"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
},
"x-examples": [
{
"name": "New Folder Name"
}
]
}
CreateFolderresponse
{
"type": "object",
"title": "CreateFolderresponse",
"example": {
"id": "457X",
"name": "New Folder Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
},
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"space",
"task_count"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"space": {
"$ref": "#/components/schemas/Space2"
},
"hidden": {
"type": "boolean"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"task_count": {
"type": "string"
},
"override_statuses": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "457X",
"name": "New Folder Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
}
]
}
CreateGoalrequest
{
"type": "object",
"title": "CreateGoalrequest",
"example": {
"name": "Goal Name",
"color": "#32a852",
"owners": [
183
],
"due_date": 1568036964079,
"description": "Goal Description",
"multiple_owners": true
},
"required": [
"name",
"due_date",
"description",
"multiple_owners",
"owners",
"color"
],
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": "Array of user IDs."
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"description": {
"type": "string"
},
"multiple_owners": {
"type": "boolean"
}
},
"x-examples": [
{
"name": "Goal Name",
"color": "#32a852",
"owners": [
183
],
"due_date": 1568036964079,
"description": "Goal Description",
"multiple_owners": true
}
]
}
CreateGoalresponse
{
"type": "object",
"title": "CreateGoalresponse",
"example": {
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal Name",
"color": "#32a852",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
}
},
"required": [
"goal"
],
"properties": {
"goal": {
"$ref": "#/components/schemas/Goal"
}
},
"x-examples": [
{
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal Name",
"color": "#32a852",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
}
}
]
}
CreateKeyResultrequest
{
"type": "object",
"title": "CreateKeyResultrequest",
"example": {
"name": "New Target Name",
"type": "number",
"unit": "km",
"owners": [
183
],
"list_ids": [],
"task_ids": [],
"steps_end": 10,
"steps_start": 0
},
"required": [
"name",
"owners",
"type",
"steps_start",
"steps_end",
"unit",
"task_ids",
"list_ids"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`."
},
"unit": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"list_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enter an array of List IDs to link this target with one or more Lists."
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enter an array of task IDs to link this target with one or more tasks."
},
"steps_end": {
"type": "integer",
"contentEncoding": "int32"
},
"steps_start": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"name": "New Target Name",
"type": "number",
"unit": "km",
"owners": [
183
],
"list_ids": [],
"task_ids": [],
"steps_end": 10,
"steps_start": 0
}
]
}
CreateKeyResultresponse
{
"type": "object",
"title": "CreateKeyResultresponse",
"example": {
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
"note": "Created Key Result",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568062902048",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"steps_current": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
}
},
"required": [
"key_result"
],
"properties": {
"key_result": {
"$ref": "#/components/schemas/KeyResult"
}
},
"x-examples": [
{
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
"note": "Created Key Result",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568062902048",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"steps_current": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
}
}
]
}
CreateListCommentrequest
{
"type": "object",
"title": "CreateListCommentrequest",
"example": {
"assignee": 183,
"notify_all": true,
"comment_text": "List 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": "List comment content"
}
]
}
CreateListCommentresponse
{
"type": "object",
"title": "CreateListCommentresponse",
"example": {
"id": "462X",
"date": 1568037341249,
"hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08"
},
"required": [
"id",
"hist_id",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
},
"hist_id": {
"type": "string"
}
},
"x-examples": [
{
"id": "462X",
"date": 1568037341249,
"hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08"
}
]
}
CreateListViewrequest
{
"type": "object",
"title": "CreateListViewrequest",
"example": {
"name": "New List 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 List 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
}
}
]
}
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
}
]
}
EditChecklistItemresponse
{
"type": "object",
"title": "EditChecklistItemresponse",
"example": {
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"children": [],
"resolved": true,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 1,
"orderindex": 0,
"unresolved": 0,
"date_created": "1567711563204"
}
},
"required": [
"checklist"
],
"properties": {
"checklist": {
"$ref": "#/components/schemas/Checklist2"
}
},
"x-examples": [
{
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"children": [],
"resolved": true,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 1,
"orderindex": 0,
"unresolved": 0,
"date_created": "1567711563204"
}
}
]
}
EditChecklistrequest
{
"type": "object",
"title": "EditChecklistrequest",
"example": {
"name": "Updated Checklist",
"position": 1
},
"properties": {
"name": {
"type": "string"
},
"position": {
"type": "integer",
"description": "Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`.",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"name": "Updated Checklist",
"position": 1
}
]
}
EditGuestOnWorkspacerequest
{
"type": "object",
"title": "EditGuestOnWorkspacerequest",
"example": {
"username": "Guest User",
"can_edit_tags": true,
"custom_role_id": 12345,
"can_create_views": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
},
"required": [
"username",
"can_edit_tags",
"can_see_time_spent",
"can_see_time_estimated",
"can_create_views",
"custom_role_id"
],
"properties": {
"username": {
"type": "string"
},
"can_edit_tags": {
"type": "boolean"
},
"custom_role_id": {
"type": "integer",
"contentEncoding": "int32"
},
"can_create_views": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
}
},
"x-examples": [
{
"username": "Guest User",
"can_edit_tags": true,
"custom_role_id": 12345,
"can_create_views": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
]
}
EditGuestOnWorkspaceresponse
{
"type": "object",
"title": "EditGuestOnWorkspaceresponse",
"example": {
"guest": {
"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
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest"
}
},
"x-examples": [
{
"guest": {
"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
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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
}
}
]
}
EditKeyResultrequest
{
"type": "object",
"title": "EditKeyResultrequest",
"example": {
"note": "Target achieved",
"steps_current": 5
},
"required": [
"steps_current",
"note"
],
"properties": {
"note": {
"type": "string"
},
"steps_current": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"note": "Target achieved",
"steps_current": 5
}
]
}
EditKeyResultresponse
{
"type": "object",
"title": "EditKeyResultresponse",
"example": {
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "e889858b-a023-46cc-968a-cac32fd04c1eX",
"note": "Target achieved",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568122776851",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"steps_current": null,
"steps_taken_float": 5,
"steps_before_float": 0,
"steps_current_float": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
}
},
"required": [
"key_result"
],
"properties": {
"key_result": {
"$ref": "#/components/schemas/KeyResult1"
}
},
"x-examples": [
{
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "e889858b-a023-46cc-968a-cac32fd04c1eX",
"note": "Target achieved",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568122776851",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"steps_current": null,
"steps_taken_float": 5,
"steps_before_float": 0,
"steps_current_float": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
}
}
]
}
EditSpaceTagrequest
{
"type": "object",
"title": "EditSpaceTagrequest",
"example": {
"tag": {
"name": "Updated Tag",
"bg_color": "#ffffff",
"fg_color": "#ffffff"
}
},
"required": [
"tag"
],
"properties": {
"tag": {
"$ref": "#/components/schemas/Tag1"
}
},
"x-examples": [
{
"tag": {
"name": "Updated Tag",
"bg_color": "#ffffff",
"fg_color": "#ffffff"
}
}
]
}
EditSpaceTagresponse
{
"type": "object",
"title": "EditSpaceTagresponse",
"example": {
"tag": {
"name": "Updated Tag",
"bg_color": "#ffffff",
"fg_color": "#ffffff"
}
},
"required": [
"tag"
],
"properties": {
"tag": {
"$ref": "#/components/schemas/Tag1"
}
},
"x-examples": [
{
"tag": {
"name": "Updated Tag",
"bg_color": "#ffffff",
"fg_color": "#ffffff"
}
}
]
}
EditUserOnWorkspacerequest
{
"type": "object",
"title": "EditUserOnWorkspacerequest",
"example": {
"admin": false,
"username": "User Name",
"custom_role_id": 998877
},
"required": [
"username",
"admin",
"custom_role_id"
],
"properties": {
"admin": {
"type": "boolean"
},
"username": {
"type": "string"
},
"custom_role_id": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"admin": false,
"username": "User Name",
"custom_role_id": 998877
}
]
}
EditUserOnWorkspaceresponse
{
"type": "object",
"title": "EditUserOnWorkspaceresponse",
"example": {
"member": {
"user": {
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "UN",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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": [
"member"
],
"properties": {
"member": {
"$ref": "#/components/schemas/Member7"
}
},
"x-examples": [
{
"member": {
"user": {
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "UN",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
}
}
]
}
Edittimetrackedrequest
{
"type": "object",
"title": "Edittimetrackedrequest",
"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
}
]
}
Emails
{
"type": "object",
"title": "Emails",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
Features
{
"type": "object",
"title": "Features",
"example": {
"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
}
},
"required": [
"due_dates",
"time_tracking",
"tags",
"time_estimates",
"checklists",
"custom_fields",
"remap_dependencies",
"dependency_warning",
"portfolios"
],
"properties": {
"tags": {
"$ref": "#/components/schemas/Tags"
},
"due_dates": {
"$ref": "#/components/schemas/DueDates"
},
"checklists": {
"$ref": "#/components/schemas/Checklists"
},
"portfolios": {
"$ref": "#/components/schemas/Portfolios"
},
"custom_fields": {
"$ref": "#/components/schemas/CustomFields"
},
"time_tracking": {
"$ref": "#/components/schemas/TimeTracking"
},
"time_estimates": {
"$ref": "#/components/schemas/TimeEstimates"
},
"dependency_warning": {
"$ref": "#/components/schemas/DependencyWarning"
},
"remap_dependencies": {
"$ref": "#/components/schemas/RemapDependencies"
}
},
"x-examples": [
{
"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
}
}
]
}
Features1
{
"type": "object",
"title": "Features1",
"example": {
"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
}
},
"required": [
"due_dates",
"sprints",
"points",
"custom_items",
"tags",
"time_estimates",
"checklists",
"zoom",
"milestones",
"custom_fields",
"remap_dependencies",
"dependency_warning",
"multiple_assignees",
"portfolios",
"emails"
],
"properties": {
"tags": {
"$ref": "#/components/schemas/Tags"
},
"zoom": {
"$ref": "#/components/schemas/Zoom"
},
"emails": {
"$ref": "#/components/schemas/Emails"
},
"points": {
"$ref": "#/components/schemas/Points"
},
"sprints": {
"$ref": "#/components/schemas/Sprints"
},
"due_dates": {
"$ref": "#/components/schemas/DueDates"
},
"checklists": {
"$ref": "#/components/schemas/Checklists"
},
"milestones": {
"$ref": "#/components/schemas/Milestones"
},
"portfolios": {
"$ref": "#/components/schemas/Portfolios"
},
"custom_items": {
"$ref": "#/components/schemas/CustomItems"
},
"custom_fields": {
"$ref": "#/components/schemas/CustomFields"
},
"time_estimates": {
"$ref": "#/components/schemas/TimeEstimates"
},
"dependency_warning": {
"$ref": "#/components/schemas/DependencyWarning"
},
"multiple_assignees": {
"$ref": "#/components/schemas/MultipleAssignees"
},
"remap_dependencies": {
"$ref": "#/components/schemas/RemapDependencies"
}
},
"x-examples": [
{
"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
}
}
]
}
Features4
{
"type": "object",
"title": "Features4",
"example": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"required": [
"due_dates",
"time_tracking",
"tags",
"time_estimates",
"checklists"
],
"properties": {
"tags": {
"$ref": "#/components/schemas/Tags"
},
"due_dates": {
"$ref": "#/components/schemas/DueDates"
},
"checklists": {
"$ref": "#/components/schemas/Checklists"
},
"portfolios": {
"$ref": "#/components/schemas/Portfolios"
},
"custom_fields": {
"$ref": "#/components/schemas/CustomFields"
},
"time_tracking": {
"$ref": "#/components/schemas/TimeTracking"
},
"time_estimates": {
"$ref": "#/components/schemas/TimeEstimates"
},
"dependency_warning": {
"$ref": "#/components/schemas/DependencyWarning"
},
"remap_dependencies": {
"$ref": "#/components/schemas/RemapDependencies"
}
},
"x-examples": [
{
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
}
]
}
Field
{
"type": "object",
"title": "Field",
"example": {
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5X",
"name": "Text Field",
"type": "text",
"type_config": {},
"date_created": "1566400407303",
"hide_from_guests": false
},
"required": [
"id",
"name",
"type",
"type_config",
"date_created",
"hide_from_guests"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"type_config": {
"$ref": "#/components/schemas/TypeConfig"
},
"date_created": {
"type": "string"
},
"hide_from_guests": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5X",
"name": "Text Field",
"type": "text",
"type_config": {},
"date_created": "1566400407303",
"hide_from_guests": false
}
]
}
Filters
{
"type": "object",
"title": "Filters",
"example": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"required": [
"op",
"fields",
"search",
"show_closed"
],
"properties": {
"op": {
"type": "string",
"description": "The available operator (`op``) values are `AND`` and `OR``."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "View the list of [fields available](https://clickup.com/api) to filter by."
},
"search": {
"type": "string"
},
"show_closed": {
"type": "boolean"
}
},
"x-examples": [
{
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
}
]
}
Folder
{
"type": "object",
"title": "Folder",
"example": {
"id": "456X"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
},
"x-examples": [
{
"id": "456X"
}
]
}
Folder11
{
"type": "object",
"title": "Folder11",
"example": {
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
},
"required": [
"id",
"name",
"orderindex",
"content",
"task_count",
"due_date",
"archived"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"content": {
"type": [
"string",
"null"
]
},
"archived": {
"type": "boolean"
},
"due_date": {
"type": [
"string",
"null"
]
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"task_count": {
"type": "string"
}
},
"x-examples": [
{
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
}
]
}
Folder2
{
"type": "object",
"title": "Folder2",
"example": {
"id": "05921253-7737-44af-a1aa-36fd11244e6fX",
"name": "Quarterly Goals",
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Q1 Goals",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"pretty_id": "8",
"start_date": null,
"description": "Goal for Q1",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"folder_access": true,
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 1
}
],
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"added_by": 183,
"initials": "JD",
"username": "Jane Doe",
"date_added": 1631599941928,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "read"
}
],
"private": true,
"team_id": "512",
"goal_count": 1,
"date_created": "1548802674671"
},
"required": [
"id",
"name",
"team_id",
"private",
"date_created",
"creator",
"goal_count",
"members",
"goals"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"goals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Goal3"
},
"description": ""
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member2"
},
"description": ""
},
"private": {
"type": "boolean"
},
"team_id": {
"type": "string"
},
"goal_count": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "05921253-7737-44af-a1aa-36fd11244e6fX",
"name": "Quarterly Goals",
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Q1 Goals",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"pretty_id": "8",
"start_date": null,
"description": "Goal for Q1",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"folder_access": true,
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 1
}
],
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"added_by": 183,
"initials": "JD",
"username": "Jane Doe",
"date_added": 1631599941928,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "read"
}
],
"private": true,
"team_id": "512",
"goal_count": 1,
"date_created": "1548802674671"
}
]
}
Folder3
{
"type": "object",
"title": "Folder3",
"example": {
"id": "1217X",
"name": "Shared with me",
"access": false,
"hidden": false
},
"required": [
"id",
"name",
"hidden",
"access"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "1217X",
"name": "Shared with me",
"access": false,
"hidden": false
}
]
}
Folder4
{
"type": "object",
"title": "Folder4",
"example": {
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
},
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"task_count",
"archived",
"statuses",
"lists",
"permission_level"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"hidden": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Status"
},
"description": ""
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"task_count": {
"type": "string"
},
"permission_level": {
"type": "string"
},
"override_statuses": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
}
Folder5
{
"type": "object",
"title": "Folder5",
"example": {
"id": "1057X",
"name": "Folder Name",
"lists": [],
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 5,
"task_count": "20",
"override_statuses": true
},
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"space",
"task_count",
"lists"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"lists": {
"type": "array",
"items": {
"type": "string"
}
},
"space": {
"$ref": "#/components/schemas/Space2"
},
"hidden": {
"type": "boolean"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"task_count": {
"type": "string"
},
"override_statuses": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 5,
"task_count": "20",
"override_statuses": true
}
]
}
FoldersRemoveFolderResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
GetAccessTokenresponse
{
"type": "object",
"title": "GetAccessTokenresponse",
"example": {
"access_token": "access token"
},
"required": [
"access_token"
],
"properties": {
"access_token": {
"type": "string"
}
},
"x-examples": [
{
"access_token": "access token"
}
]
}
GetAccessibleCustomFieldsresponse
{
"type": "object",
"title": "GetAccessibleCustomFieldsresponse",
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"description": ""
}
}
}
GetAuthorizedTeamsresponse
{
"type": "object",
"title": "GetAuthorizedTeamsresponse",
"example": {
"teams": [
{
"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": [
"teams"
],
"properties": {
"teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Team"
},
"description": ""
}
},
"x-examples": [
{
"teams": [
{
"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"
}
}
]
}
]
}
]
}
GetAuthorizedUserresponse
{
"type": "object",
"title": "GetAuthorizedUserresponse",
"example": {
"user": {
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
},
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User"
}
},
"x-examples": [
{
"user": {
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
}
]
}
GetBulkTasksTimeinStatusresponse
{
"type": "object",
"title": "GetBulkTasksTimeinStatusresponse",
"example": {
"20bbn28": {
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004420925",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004420925",
"by_minute": 22276
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1601597828835",
"by_minute": 40109
}
}
]
},
"27075wz": {
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21829
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1602607941692",
"by_minute": 23274
}
}
]
}
},
"required": [
"27075wz",
"20bbn28"
],
"properties": {
"20bbn28": {
"$ref": "#/components/schemas/20bbn28"
},
"27075wz": {
"$ref": "#/components/schemas/27075wz"
}
},
"x-examples": [
{
"20bbn28": {
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004420925",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004420925",
"by_minute": 22276
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1601597828835",
"by_minute": 40109
}
}
]
},
"27075wz": {
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21829
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1602607941692",
"by_minute": 23274
}
}
]
}
}
]
}
GetChatViewCommentsresponse
{
"type": "object",
"title": "GetChatViewCommentsresponse",
"example": {
"comments": [
{
"id": "459X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "View comment content"
}
],
"assignee": null,
"resolved": false,
"reactions": [],
"assigned_by": null,
"comment_text": "View comment content"
}
]
},
"required": [
"comments"
],
"properties": {
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment2"
},
"description": ""
}
},
"x-examples": [
{
"comments": [
{
"id": "459X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "View comment content"
}
],
"assignee": null,
"resolved": false,
"reactions": [],
"assigned_by": null,
"comment_text": "View comment content"
}
]
}
]
}
GetCustomItemsResponse
{
"type": "object",
"title": "GetCustomItemsResponse",
"example": {
"custom_items": [
{
"id": "1300-900e-462d-a849-4a216b06d930",
"name": "Bug",
"description": "Custom item type for bugs.",
"name_plural": "Bugs"
}
]
},
"properties": {
"custom_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomItem"
},
"description": "Array of custom task types."
}
},
"x-examples": [
{
"custom_items": [
{
"id": "1300-900e-462d-a849-4a216b06d930",
"name": "Bug",
"description": "Custom item type for bugs.",
"name_plural": "Bugs"
}
]
}
]
}
GetCustomRolesresponse
{
"type": "object",
"title": "GetCustomRolesresponse",
"example": {
"custom_roles": [
{
"id": 4547089,
"name": "guest custom",
"members": [
12345,
67899
],
"team_id": "301539",
"date_created": "1651189835671",
"inherited_role": 4
},
{
"id": 6715664,
"name": "member custom",
"members": [
5553,
98989
],
"team_id": "301539",
"date_created": "1651189901020",
"inherited_role": 3
},
{
"id": 2957195,
"name": "admin custom",
"members": [
47474,
818181
],
"team_id": "301539",
"date_created": "1651189904868",
"inherited_role": 2
}
]
},
"required": [
"custom_roles"
],
"properties": {
"custom_roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomRole2"
},
"description": ""
}
},
"x-examples": [
{
"custom_roles": [
{
"id": 4547089,
"name": "guest custom",
"members": [
12345,
67899
],
"team_id": "301539",
"date_created": "1651189835671",
"inherited_role": 4
},
{
"id": 6715664,
"name": "member custom",
"members": [
5553,
98989
],
"team_id": "301539",
"date_created": "1651189901020",
"inherited_role": 3
},
{
"id": 2957195,
"name": "admin custom",
"members": [
47474,
818181
],
"team_id": "301539",
"date_created": "1651189904868",
"inherited_role": 2
}
]
}
]
}
GetFilteredTeamTasksresponse
{
"type": "object",
"title": "GetFilteredTeamTasksresponse",
"example": {
"tasks": [
{
"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,
"date_done": "1508369194377",
"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": [
"tasks"
],
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task3"
},
"description": ""
}
},
"x-examples": [
{
"tasks": [
{
"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,
"date_done": "1508369194377",
"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"
}
]
}
]
}
GetFolderViewsresponse
{
"type": "object",
"title": "GetFolderViewsresponse",
"example": {
"views": [
{
"id": "3c-107X",
"name": "New Folder View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "457X",
"type": 5
},
"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": [
"views"
],
"properties": {
"views": {
"type": "array",
"items": {
"$ref": "#/components/schemas/View"
},
"description": ""
}
},
"x-examples": [
{
"views": [
{
"id": "3c-107X",
"name": "New Folder View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "457X",
"type": 5
},
"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
}
}
]
}
]
}
GetFolderlessListsresponse
{
"type": "object",
"title": "GetFolderlessListsresponse",
"required": [
"lists"
],
"properties": {
"lists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/List4"
},
"description": ""
}
}
}
GetFolderresponse
{
"type": "object",
"title": "GetFolderresponse",
"example": {
"id": "457X",
"name": "Updated Folder Name",
"lists": [],
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
},
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"space",
"task_count",
"lists"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"space": {
"$ref": "#/components/schemas/Space2"
},
"hidden": {
"type": "boolean"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"task_count": {
"type": "string"
},
"override_statuses": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "457X",
"name": "Updated Folder Name",
"lists": [],
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
}
]
}
GetFoldersresponse
{
"type": "object",
"title": "GetFoldersresponse",
"example": {
"folders": [
{
"id": "457X",
"name": "Updated Folder Name",
"lists": [],
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
},
{
"id": "321",
"name": "Folder Name",
"lists": [],
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
}
]
},
"required": [
"folders"
],
"properties": {
"folders": {
"$ref": "#/components/schemas/Folder5"
}
},
"x-examples": [
{
"folders": [
{
"id": "457X",
"name": "Updated Folder Name",
"lists": [],
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
},
{
"id": "321",
"name": "Folder Name",
"lists": [],
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
}
]
}
]
}
GetGoalresponse
{
"type": "object",
"title": "GetGoalresponse",
"example": {
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Updated Goal Name",
"color": "#32a852",
"owners": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Updated Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
}
},
"required": [
"goal"
],
"properties": {
"goal": {
"$ref": "#/components/schemas/Goal"
}
},
"x-examples": [
{
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Updated Goal Name",
"color": "#32a852",
"owners": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Updated Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
}
}
]
}
GetGoalsresponse
{
"type": "object",
"title": "GetGoalsresponse",
"example": {
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal ABC",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"start_date": null,
"description": "Updated Goal Description",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675",
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 0
}
],
"folders": [
{
"id": "05921253-7737-44af-a1aa-36fd11244e6fX",
"name": "Quarterly Goals",
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Q1 Goals",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"pretty_id": "8",
"start_date": null,
"description": "Goal for Q1",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"folder_access": true,
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 1
}
],
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"added_by": 183,
"initials": "JD",
"username": "Jane Doe",
"date_added": 1631599941928,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "read"
}
],
"private": true,
"team_id": "512",
"goal_count": 1,
"date_created": "1548802674671"
}
]
},
"required": [
"goals",
"folders"
],
"properties": {
"goals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Goal2"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Folder2"
},
"description": ""
}
},
"x-examples": [
{
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal ABC",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"start_date": null,
"description": "Updated Goal Description",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675",
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 0
}
],
"folders": [
{
"id": "05921253-7737-44af-a1aa-36fd11244e6fX",
"name": "Quarterly Goals",
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Q1 Goals",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"pretty_id": "8",
"start_date": null,
"description": "Goal for Q1",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"folder_access": true,
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 1
}
],
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"added_by": 183,
"initials": "JD",
"username": "Jane Doe",
"date_added": 1631599941928,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "read"
}
],
"private": true,
"team_id": "512",
"goal_count": 1,
"date_created": "1548802674671"
}
]
}
]
}
GetListCommentsresponse
{
"type": "object",
"title": "GetListCommentsresponse",
"example": {
"comments": [
{
"id": "462X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "List comment content"
}
],
"assignee": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"reactions": [],
"assigned_by": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment_text": "List comment content"
}
]
},
"required": [
"comments"
],
"properties": {
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment"
},
"description": ""
}
},
"x-examples": [
{
"comments": [
{
"id": "462X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "List comment content"
}
],
"assignee": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"reactions": [],
"assigned_by": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment_text": "List comment content"
}
]
}
]
}
GetListMembersresponse
{
"type": "object",
"title": "GetListMembersresponse",
"example": {
"members": [
{
"id": 812,
"color": "#FFFFFF",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg"
},
{
"id": 813,
"color": null,
"email": "jane@example.com",
"initials": "JD",
"username": "Jane Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg"
}
]
},
"required": [
"members"
],
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member5"
},
"description": ""
}
},
"x-examples": [
{
"members": [
{
"id": 812,
"color": "#FFFFFF",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg"
},
{
"id": 813,
"color": null,
"email": "jane@example.com",
"initials": "JD",
"username": "Jane Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg"
}
]
}
]
}
GetListViewsresponse
{
"type": "object",
"title": "GetListViewsresponse",
"example": {
"views": [
{
"id": "3c-107X",
"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": [
"views"
],
"properties": {
"views": {
"type": "array",
"items": {
"$ref": "#/components/schemas/View"
},
"description": ""
}
},
"x-examples": [
{
"views": [
{
"id": "3c-107X",
"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
}
}
]
}
]
}
GetListresponse
{
"type": "object",
"title": "GetListresponse",
"example": {
"id": "124X",
"name": "Updated 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": "Updated List Content",
"archived": false,
"assignee": null,
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "high"
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"orderindex": 1,
"start_date": null,
"due_date_time": true,
"inbound_address": "add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
"start_date_time": null,
"permission_level": "create",
"override_statuses": false
},
"required": [
"id",
"name",
"orderindex",
"content",
"status",
"priority",
"assignee",
"due_date",
"due_date_time",
"start_date",
"start_date_time",
"folder",
"space",
"inbound_address",
"archived",
"override_statuses",
"statuses",
"permission_level"
],
"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"
},
"archived": {
"type": "boolean"
},
"assignee": {
"type": [
"string",
"null"
]
},
"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"
]
},
"due_date_time": {
"type": "boolean"
},
"inbound_address": {
"type": "string"
},
"start_date_time": {
"type": [
"string",
"null"
]
},
"permission_level": {
"type": "string"
},
"override_statuses": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "124X",
"name": "Updated 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": "Updated List Content",
"archived": false,
"assignee": null,
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "high"
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"orderindex": 1,
"start_date": null,
"due_date_time": true,
"inbound_address": "add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
"start_date_time": null,
"permission_level": "create",
"override_statuses": false
}
]
}
GetListsresponse
{
"type": "object",
"title": "GetListsresponse",
"required": [
"lists"
],
"properties": {
"lists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/List4"
},
"description": ""
}
}
}
GetSpaceTagsresponse
{
"type": "object",
"title": "GetSpaceTagsresponse",
"example": {
"tags": [
{
"name": "Tag name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
]
},
"required": [
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags6"
},
"description": ""
}
},
"x-examples": [
{
"tags": [
{
"name": "Tag name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
]
}
]
}
GetSpaceViewsresponse
{
"type": "object",
"title": "GetSpaceViewsresponse",
"example": {
"views": [
{
"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": []
},
"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": [
"views"
],
"properties": {
"views": {
"type": "array",
"items": {
"$ref": "#/components/schemas/View"
},
"description": ""
}
},
"x-examples": [
{
"views": [
{
"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": []
},
"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
}
}
]
}
]
}
GetSpaceresponse
{
"type": "object",
"title": "GetSpaceresponse",
"example": {
"id": "790X",
"name": "Updated Space Name",
"private": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"multiple_assignees": false
},
"required": [
"id",
"name",
"private",
"statuses",
"multiple_assignees",
"features"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"features": {
"$ref": "#/components/schemas/Features"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Status"
},
"description": ""
},
"multiple_assignees": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "790X",
"name": "Updated Space Name",
"private": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"multiple_assignees": false
}
]
}
GetSpacesresponse
{
"type": "object",
"title": "GetSpacesresponse",
"example": {
"spaces": [
{
"id": "790X",
"name": "Updated Space Name",
"color": null,
"avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"members": [
{
"user": {
"id": "12312312,X",
"color": null,
"initials": "JJ",
"username": "John Jones,",
"profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg,"
}
}
],
"private": false,
"archived": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"admin_can_manage": true,
"multiple_assignees": false
},
{
"id": "791X",
"name": "Second Space Name",
"private": false,
"features": {
"tags": {
"enabled": true
},
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"time_tracking": {
"enabled": true
},
"time_estimates": {
"enabled": true
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 1
}
],
"multiple_assignees": true
}
]
},
"required": [
"spaces"
],
"properties": {
"spaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Space13"
},
"description": ""
}
},
"x-examples": [
{
"spaces": [
{
"id": "790X",
"name": "Updated Space Name",
"color": null,
"avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"members": [
{
"user": {
"id": "12312312,X",
"color": null,
"initials": "JJ",
"username": "John Jones,",
"profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg,"
}
}
],
"private": false,
"archived": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"admin_can_manage": true,
"multiple_assignees": false
},
{
"id": "791X",
"name": "Second Space Name",
"private": false,
"features": {
"tags": {
"enabled": true
},
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"time_tracking": {
"enabled": true
},
"time_estimates": {
"enabled": true
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 1
}
],
"multiple_assignees": true
}
]
}
]
}
GetTaskCommentsresponse
{
"type": "object",
"title": "GetTaskCommentsresponse",
"example": {
"comments": [
{
"id": "458X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "Task comment content"
}
],
"assignee": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"reactions": [],
"assigned_by": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment_text": "Task comment content"
}
]
},
"required": [
"comments"
],
"properties": {
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment"
},
"description": ""
}
},
"x-examples": [
{
"comments": [
{
"id": "458X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "Task comment content"
}
],
"assignee": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"reactions": [],
"assigned_by": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment_text": "Task comment content"
}
]
}
]
}
GetTaskMembersresponse
{
"type": "object",
"title": "GetTaskMembersresponse",
"example": {
"members": [
{
"id": 812,
"color": "#FFFFFF",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg"
},
{
"id": 813,
"color": null,
"email": "jane@example.com",
"initials": "JD",
"username": "Jane Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg"
}
]
},
"required": [
"members"
],
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member5"
},
"description": ""
}
},
"x-examples": [
{
"members": [
{
"id": 812,
"color": "#FFFFFF",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg"
},
{
"id": 813,
"color": null,
"email": "jane@example.com",
"initials": "JD",
"username": "Jane Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg"
}
]
}
]
}
GetTaskTemplatesresponse
{
"type": "object",
"title": "GetTaskTemplatesresponse",
"example": {
"templates": []
},
"required": [
"templates"
],
"properties": {
"templates": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"templates": []
}
]
}
GetTaskresponse
{
"type": "object",
"title": "GetTaskresponse",
"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": ""
},
"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"
]
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
}
},
"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."
},
"markdown_description": {
"type": "string"
}
}
}
GetTasksTimeinStatusresponse
{
"type": "object",
"title": "GetTasksTimeinStatusresponse",
"example": {
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21708
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21707
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status",
"orderindex": 4,
"total_time": {
"since": "1602607941692",
"by_minute": 23274
}
}
]
},
"required": [
"current_status",
"status_history"
],
"properties": {
"current_status": {
"$ref": "#/components/schemas/CurrentStatus"
},
"status_history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusHistory"
},
"description": ""
}
},
"x-examples": [
{
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21708
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21707
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status",
"orderindex": 4,
"total_time": {
"since": "1602607941692",
"by_minute": 23274
}
}
]
}
]
}
GetTasksresponse
{
"type": "object",
"title": "GetViewTasksresponse",
"example": {
"tasks": [
{
"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"
},
{
"id": "9hzX",
"url": "https://app.clickup.com/t/9hz",
"list": {
"id": "123X"
},
"name": "Second task",
"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": "2.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"time_estimate": null,
"custom_item_id": null
}
]
},
"required": [
"tasks",
"last_page"
],
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task9"
},
"description": ""
},
"last_page": {
"type": "boolean"
}
},
"x-examples": [
{
"tasks": [
{
"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"
},
{
"id": "9hzX",
"url": "https://app.clickup.com/t/9hz",
"list": {
"id": "123X"
},
"name": "Second task",
"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": "2.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"time_estimate": null,
"custom_item_id": null
}
]
}
]
}
GetTeamViewsresponse
{
"type": "object",
"title": "GetTeamViewsresponse",
"example": {
"views": [
{
"id": "3c-105X",
"name": "New 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": [
"views"
],
"properties": {
"views": {
"type": "array",
"items": {
"$ref": "#/components/schemas/View"
},
"description": ""
}
},
"x-examples": [
{
"views": [
{
"id": "3c-105X",
"name": "New 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
}
}
]
}
]
}
GetTeamsresponse
{
"type": "object",
"title": "GetTeamsresponse",
"example": {
"groups": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870dX",
"name": "product team",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "product",
"userid": 301123,
"members": [
{
"id": 183,
"color": "#40BC86",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": null
},
{
"id": 184,
"color": "#FF8600",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": null
}
],
"team_id": "123456",
"initials": "PT",
"date_created": "1640122639829"
},
{
"id": "fd31be63-41f2-4320-9043-9786fdf643d6X",
"name": "HR department",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "hr-dept",
"userid": 301828,
"members": [
{
"id": 183,
"color": "#40BC86",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
],
"team_id": "301540",
"initials": "HD",
"date_created": "1627087990293"
}
]
},
"required": [
"groups"
],
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
},
"description": ""
}
},
"x-examples": [
{
"groups": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870dX",
"name": "product team",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "product",
"userid": 301123,
"members": [
{
"id": 183,
"color": "#40BC86",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": null
},
{
"id": 184,
"color": "#FF8600",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": null
}
],
"team_id": "123456",
"initials": "PT",
"date_created": "1640122639829"
},
{
"id": "fd31be63-41f2-4320-9043-9786fdf643d6X",
"name": "HR department",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "hr-dept",
"userid": 301828,
"members": [
{
"id": 183,
"color": "#40BC86",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
],
"team_id": "301540",
"initials": "HD",
"date_created": "1627087990293"
}
]
}
]
}
GetUserresponse
{
"type": "object",
"title": "GetUserresponse",
"example": {
"member": {
"user": {
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "UN",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
}
},
"properties": {
"member": {
"$ref": "#/components/schemas/Member7"
}
},
"x-examples": [
{
"member": {
"user": {
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "UN",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
}
}
]
}
GetViewTasksresponse
{
"type": "object",
"title": "GetViewTasksresponse",
"example": {
"tasks": [
{
"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,
"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
},
{
"id": "9hzX",
"url": "https://app.clickup.com/t/9hz",
"list": {
"id": "123X"
},
"name": "Second task",
"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,
"assignees": [],
"date_done": null,
"checklists": [],
"orderindex": "2.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"time_estimate": null
}
],
"last_page": true
},
"required": [
"tasks",
"last_page"
],
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task9"
},
"description": ""
},
"last_page": {
"type": "boolean"
}
},
"x-examples": [
{
"tasks": [
{
"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,
"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
},
{
"id": "9hzX",
"url": "https://app.clickup.com/t/9hz",
"list": {
"id": "123X"
},
"name": "Second task",
"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,
"assignees": [],
"date_done": null,
"checklists": [],
"orderindex": "2.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"time_estimate": null
}
],
"last_page": true
}
]
}
GetViewresponse
{
"type": "object",
"title": "GetViewresponse",
"example": {
"view": {
"id": "3c-105X",
"name": "New 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 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
}
}
}
]
}
GetWebhooksresponse
{
"type": "object",
"title": "GetWebhooksresponse",
"example": {
"webhooks": [
{
"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": "failing",
"fail_count": 5
},
"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": [
"webhooks"
],
"properties": {
"webhooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
},
"description": ""
}
},
"x-examples": [
{
"webhooks": [
{
"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": "failing",
"fail_count": 5
},
"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
}
]
}
]
}
GetWorkspaceplanresponse
{
"type": "object",
"title": "GetWorkspaceplanresponse",
"example": {
"plan_id": 4,
"plan_name": "Enterprise"
},
"properties": {
"plan_id": {
"type": "integer"
},
"plan_name": {
"type": "string"
}
},
"x-examples": [
{
"plan_id": 4,
"plan_name": "Enterprise"
}
]
}
GetWorkspaceseatsresponse
{
"type": "object",
"title": "GetWorkspaceseatsresponse",
"example": {
"guests": {
"empty_guest_seats": 48,
"total_guest_seats": 50,
"filled_guest_seats": 2
},
"members": {
"empty_member_seats": 0,
"total_member_seats": 9,
"filled_members_seats": 9
}
},
"required": [
"members",
"guests"
],
"properties": {
"guests": {
"$ref": "#/components/schemas/Guests"
},
"members": {
"$ref": "#/components/schemas/Members"
}
},
"x-examples": [
{
"guests": {
"empty_guest_seats": 48,
"total_guest_seats": 50,
"filled_guest_seats": 2
},
"members": {
"empty_member_seats": 0,
"total_member_seats": 9,
"filled_members_seats": 9
}
}
]
}
Getalltagsfromtimeentriesresponse
{
"type": "object",
"title": "Getalltagsfromtimeentriesresponse",
"example": {
"data": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF",
"creator": 1
}
]
},
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Data1"
},
"description": ""
}
},
"x-examples": [
{
"data": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF",
"creator": 1
}
]
}
]
}
Getrunningtimeentryresponse
{
"type": "object",
"title": "Getrunningtimeentryresponse",
"example": {
"data": {
"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": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Data"
}
},
"x-examples": [
{
"data": {
"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": ""
}
}
]
}
Getsingulartimeentryresponse
{
"type": "object",
"title": "Getsingulartimeentryresponse",
"example": {
"data": [
{
"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": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Datum2"
},
"description": ""
}
},
"x-examples": [
{
"data": [
{
"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"
}
}
]
}
]
}
Gettimeentrieswithinadaterangeresponse
{
"type": "object",
"title": "Gettimeentrieswithinadaterangeresponse",
"example": {
"data": [
{
"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": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Datum1"
},
"description": ""
}
},
"x-examples": [
{
"data": [
{
"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"
}
}
]
}
]
}
Gettrackedtimeresponse
{
"type": "object",
"title": "Gettrackedtimeresponse",
"example": {
"data": [
{
"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": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Datum"
},
"description": ""
}
},
"x-examples": [
{
"data": [
{
"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"
}
]
}
]
}
]
}
Goal
{
"type": "object",
"title": "Goal",
"example": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal Name",
"color": "#32a852",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
},
"required": [
"id",
"name",
"team_id",
"date_created",
"start_date",
"due_date",
"description",
"private",
"archived",
"creator",
"color",
"pretty_id",
"multiple_owners",
"folder_id",
"members",
"owners",
"key_results",
"percent_completed",
"history",
"pretty_url"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Owner"
},
"description": ""
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"history": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"private": {
"type": "boolean"
},
"team_id": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"due_date": {
"type": "string"
},
"folder_id": {
"type": [
"string",
"null"
]
},
"pretty_id": {
"type": "string"
},
"pretty_url": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"key_results": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"date_created": {
"type": "string"
},
"multiple_owners": {
"type": "boolean"
},
"percent_completed": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal Name",
"color": "#32a852",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
}
]
}
Goal2
{
"type": "object",
"title": "Goal2",
"example": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal ABC",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"start_date": null,
"description": "Updated Goal Description",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675",
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 0
},
"required": [
"id",
"pretty_id",
"name",
"team_id",
"creator",
"owner",
"color",
"date_created",
"start_date",
"due_date",
"description",
"private",
"archived",
"multiple_owners",
"editor_token",
"date_updated",
"last_update",
"folder_id",
"pinned",
"owners",
"key_result_count",
"members",
"group_members",
"percent_completed"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"owner": {
"type": [
"string",
"null"
]
},
"owners": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"pinned": {
"type": "boolean"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member1"
},
"description": ""
},
"private": {
"type": "boolean"
},
"team_id": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"due_date": {
"type": "string"
},
"folder_id": {
"type": [
"string",
"null"
]
},
"pretty_id": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"last_update": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"editor_token": {
"type": "string"
},
"group_members": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"multiple_owners": {
"type": "boolean"
},
"key_result_count": {
"type": "integer",
"contentEncoding": "int32"
},
"percent_completed": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal ABC",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"start_date": null,
"description": "Updated Goal Description",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675",
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 0
}
]
}
Goal3
{
"type": "object",
"title": "Goal3",
"example": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Q1 Goals",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"pretty_id": "8",
"start_date": null,
"description": "Goal for Q1",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"folder_access": true,
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 1
},
"required": [
"id",
"pretty_id",
"name",
"team_id",
"creator",
"owner",
"color",
"date_created",
"start_date",
"due_date",
"description",
"private",
"archived",
"multiple_owners",
"editor_token",
"date_updated",
"last_update",
"folder_id",
"folder_access",
"pinned",
"owners",
"key_result_count",
"members",
"group_members",
"percent_completed"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"owner": {
"type": [
"string",
"null"
]
},
"owners": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"pinned": {
"type": "boolean"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member1"
},
"description": ""
},
"private": {
"type": "boolean"
},
"team_id": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"due_date": {
"type": "string"
},
"folder_id": {
"type": "string"
},
"pretty_id": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"last_update": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"editor_token": {
"type": "string"
},
"folder_access": {
"type": "boolean"
},
"group_members": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"multiple_owners": {
"type": "boolean"
},
"key_result_count": {
"type": "integer",
"contentEncoding": "int32"
},
"percent_completed": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Q1 Goals",
"color": "#32a852",
"owner": null,
"owners": [],
"pinned": false,
"creator": 182,
"members": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"pretty_id": "8",
"start_date": null,
"description": "Goal for Q1",
"last_update": "1626132992152",
"date_created": "1568044355026",
"date_updated": "1626130440221",
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"folder_access": true,
"group_members": [],
"multiple_owners": true,
"key_result_count": 1,
"percent_completed": 1
}
]
}
GoalsRemoveGoalResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
GoalsRemoveTargetResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
Group
{
"type": "object",
"title": "Group",
"example": {
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870dX",
"name": "product team",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "product",
"userid": 301123,
"members": [
{
"id": 183,
"color": "#40BC86",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": null
},
{
"id": 184,
"color": "#FF8600",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": null
}
],
"team_id": "123456",
"initials": "PT",
"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/Members3"
},
"description": ""
},
"team_id": {
"type": "string"
},
"initials": {
"type": "string"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870dX",
"name": "product team",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "product",
"userid": 301123,
"members": [
{
"id": 183,
"color": "#40BC86",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": null
},
{
"id": 184,
"color": "#FF8600",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": null
}
],
"team_id": "123456",
"initials": "PT",
"date_created": "1640122639829"
}
]
}
Grouping
{
"type": "object",
"title": "Grouping",
"example": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"required": [
"field",
"dir",
"collapsed",
"ignore"
],
"properties": {
"dir": {
"type": "integer",
"description": "Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.",
"contentEncoding": "int32"
},
"field": {
"type": "string",
"description": "Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`."
},
"ignore": {
"type": "boolean"
},
"collapsed": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
}
]
}
Guest
{
"type": "object",
"title": "Guest",
"example": {
"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
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"can_create_views",
"shared"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User5"
},
"shared": {
"$ref": "#/components/schemas/Shared"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
},
"can_edit_tags": {
"type": "boolean"
},
"can_create_views": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
}
},
"x-examples": [
{
"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
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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
}
]
}
Guest1
{
"type": "object",
"title": "Guest1",
"example": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [
{
"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"
}
],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
},
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"shared"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User7"
},
"shared": {
"$ref": "#/components/schemas/Shared1"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
},
"can_edit_tags": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
}
},
"x-examples": [
{
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [
{
"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"
}
],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
]
}
Guest2
{
"type": "object",
"title": "Guest2",
"example": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
},
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"shared"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User7"
},
"shared": {
"$ref": "#/components/schemas/Shared"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
},
"can_edit_tags": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
}
},
"x-examples": [
{
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
]
}
Guest3
{
"type": "object",
"title": "Guest3",
"example": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
},
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"shared"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User7"
},
"shared": {
"$ref": "#/components/schemas/Shared3"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
},
"can_edit_tags": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
}
},
"x-examples": [
{
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
]
}
Guest5
{
"type": "object",
"title": "Guest5",
"example": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
},
"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_see_time_spent": true,
"can_see_time_estimated": true
},
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"shared"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User7"
},
"shared": {
"$ref": "#/components/schemas/Shared5"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
},
"can_edit_tags": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
}
},
"x-examples": [
{
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
]
}
Guests
{
"type": "object",
"title": "Guests",
"example": {
"empty_guest_seats": 48,
"total_guest_seats": 50,
"filled_guest_seats": 2
},
"required": [
"filled_guest_seats",
"total_guest_seats",
"empty_guest_seats"
],
"properties": {
"empty_guest_seats": {
"type": "integer",
"contentEncoding": "int32"
},
"total_guest_seats": {
"type": "integer",
"contentEncoding": "int32"
},
"filled_guest_seats": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"empty_guest_seats": 48,
"total_guest_seats": 50,
"filled_guest_seats": 2
}
]
}
GuestsGetGuestInformationResponse
{
"type": "object",
"contentMediaType": "application/json"
}
Health
{
"type": "object",
"title": "Health",
"example": {
"status": "active",
"fail_count": 0
},
"required": [
"status",
"fail_count"
],
"properties": {
"status": {
"type": "string"
},
"fail_count": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"status": "active",
"fail_count": 0
}
]
}
Interval
{
"type": "object",
"title": "Interval",
"example": {
"id": "318X",
"end": null,
"time": "1000000",
"start": null,
"source": "chrome",
"date_added": "1569983937761"
},
"required": [
"id",
"start",
"end",
"time",
"source",
"date_added"
],
"properties": {
"id": {
"type": "string"
},
"end": {
"type": [
"string",
"null"
]
},
"time": {
"type": "string"
},
"start": {
"type": [
"string",
"null"
]
},
"source": {
"type": "string"
},
"date_added": {
"type": "string"
}
},
"x-examples": [
{
"id": "318X",
"end": null,
"time": "1000000",
"start": null,
"source": "chrome",
"date_added": "1569983937761"
}
]
}
InviteGuestToWorkspacerequest
{
"type": "object",
"title": "InviteGuestToWorkspacerequest",
"example": {
"email": "guest@example.com",
"can_edit_tags": true,
"custom_role_id": 12345,
"can_create_views": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
},
"required": [
"email",
"can_edit_tags",
"can_see_time_spent",
"can_see_time_estimated",
"can_create_views",
"custom_role_id"
],
"properties": {
"email": {
"type": "string"
},
"can_edit_tags": {
"type": "boolean"
},
"custom_role_id": {
"type": "integer",
"contentEncoding": "int32"
},
"can_create_views": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
}
},
"x-examples": [
{
"email": "guest@example.com",
"can_edit_tags": true,
"custom_role_id": 12345,
"can_create_views": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
]
}
InviteGuestToWorkspaceresponse
{
"type": "object",
"title": "InviteGuestToWorkspaceresponse",
"example": {
"team": {
"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": [
"team"
],
"properties": {
"team": {
"$ref": "#/components/schemas/Team1"
}
},
"x-examples": [
{
"team": {
"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
}
]
}
}
]
}
InviteUserToWorkspacerequest
{
"type": "object",
"title": "InviteUserToWorkspacerequest",
"example": {
"admin": true,
"email": "user@example.com",
"custom_role_id": 112233
},
"required": [
"email",
"admin"
],
"properties": {
"admin": {
"type": "boolean"
},
"email": {
"type": "string"
},
"custom_role_id": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"admin": true,
"email": "user@example.com",
"custom_role_id": 112233
}
]
}
InviteUserToWorkspaceresponse
{
"type": "object",
"title": "InviteUserToWorkspaceresponse",
"example": {
"team": {
"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": [
"team"
],
"properties": {
"team": {
"$ref": "#/components/schemas/Team3"
}
},
"x-examples": [
{
"team": {
"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"
}
}
]
}
}
]
}
InvitedBy
{
"type": "object",
"title": "InvitedBy",
"example": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
]
}
Item
{
"type": "object",
"title": "Item",
"example": {
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
},
"required": [
"id",
"name",
"orderindex",
"assignee",
"resolved",
"parent",
"date_created",
"children"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"type": [
"string",
"null"
]
},
"assignee": {
"$ref": "#/components/schemas/Assignee"
},
"children": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"resolved": {
"type": "boolean"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
}
]
}
Item1
{
"type": "object",
"title": "Item1",
"example": {
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"children": [],
"resolved": true,
"orderindex": 0,
"date_created": "1567711566859"
},
"required": [
"id",
"name",
"orderindex",
"assignee",
"resolved",
"parent",
"date_created",
"children"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"type": [
"string",
"null"
]
},
"assignee": {
"type": [
"string",
"null"
]
},
"children": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"resolved": {
"type": "boolean"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"children": [],
"resolved": true,
"orderindex": 0,
"date_created": "1567711566859"
}
]
}
KeyResult
{
"type": "object",
"title": "KeyResult",
"example": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
"note": "Created Key Result",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568062902048",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"steps_current": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
},
"required": [
"id",
"goal_id",
"name",
"type",
"unit",
"creator",
"date_created",
"goal_pretty_id",
"percent_completed",
"completed",
"task_ids",
"subcategory_ids",
"owners",
"last_action"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"unit": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Owner"
},
"description": ""
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"goal_id": {
"type": "string"
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"completed": {
"type": "boolean"
},
"last_action": {
"$ref": "#/components/schemas/LastAction"
},
"date_created": {
"type": "string"
},
"goal_pretty_id": {
"type": "string"
},
"subcategory_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"percent_completed": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
"note": "Created Key Result",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568062902048",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"steps_current": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
}
]
}
KeyResult1
{
"type": "object",
"title": "KeyResult1",
"example": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "e889858b-a023-46cc-968a-cac32fd04c1eX",
"note": "Target achieved",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568122776851",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"steps_current": null,
"steps_taken_float": 5,
"steps_before_float": 0,
"steps_current_float": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
},
"required": [
"id",
"goal_id",
"name",
"type",
"unit",
"creator",
"date_created",
"goal_pretty_id",
"percent_completed",
"completed",
"task_ids",
"subcategory_ids",
"owners",
"last_action"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"unit": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Owner"
},
"description": ""
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"goal_id": {
"type": "string"
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"completed": {
"type": "boolean"
},
"last_action": {
"$ref": "#/components/schemas/LastAction1"
},
"date_created": {
"type": "string"
},
"goal_pretty_id": {
"type": "string"
},
"subcategory_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"percent_completed": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "e889858b-a023-46cc-968a-cac32fd04c1eX",
"note": "Target achieved",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568122776851",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"steps_current": null,
"steps_taken_float": 5,
"steps_before_float": 0,
"steps_current_float": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
}
]
}
LastAction
{
"type": "object",
"title": "LastAction",
"example": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
"note": "Created Key Result",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568062902048",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"steps_current": null
},
"required": [
"id",
"key_result_id",
"userid",
"date_modified",
"steps_taken",
"note",
"steps_before",
"steps_current"
],
"properties": {
"id": {
"type": "string"
},
"note": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"steps_taken": {
"type": [
"string",
"null"
]
},
"steps_before": {
"type": [
"string",
"null"
]
},
"date_modified": {
"type": "string"
},
"key_result_id": {
"type": "string"
},
"steps_current": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
"note": "Created Key Result",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568062902048",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"steps_current": null
}
]
}
LastAction1
{
"type": "object",
"title": "LastAction1",
"example": {
"id": "e889858b-a023-46cc-968a-cac32fd04c1eX",
"note": "Target achieved",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568122776851",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"steps_current": null,
"steps_taken_float": 5,
"steps_before_float": 0,
"steps_current_float": null
},
"required": [
"id",
"key_result_id",
"userid",
"date_modified",
"steps_taken",
"note",
"steps_before",
"steps_current",
"steps_before_float",
"steps_taken_float",
"steps_current_float"
],
"properties": {
"id": {
"type": "string"
},
"note": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"steps_taken": {
"type": [
"string",
"null"
]
},
"steps_before": {
"type": [
"string",
"null"
]
},
"date_modified": {
"type": "string"
},
"key_result_id": {
"type": "string"
},
"steps_current": {
"type": [
"string",
"null"
]
},
"steps_taken_float": {
"type": "integer",
"contentEncoding": "int32"
},
"steps_before_float": {
"type": "integer",
"contentEncoding": "int32"
},
"steps_current_float": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": "e889858b-a023-46cc-968a-cac32fd04c1eX",
"note": "Target achieved",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568122776851",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"steps_current": null,
"steps_taken_float": 5,
"steps_before_float": 0,
"steps_current_float": null
}
]
}
LinkedTask
{
"type": "object",
"title": "LinkedTask",
"example": {
"userid": "183",
"link_id": "9hz",
"task_id": "9hv",
"date_created": "1587571108988"
},
"required": [
"task_id",
"link_id",
"date_created",
"userid"
],
"properties": {
"userid": {
"type": "string"
},
"link_id": {
"type": "string"
},
"task_id": {
"type": "string"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"userid": "183",
"link_id": "9hz",
"task_id": "9hv",
"date_created": "1587571108988"
}
]
}
List
{
"type": "object",
"title": "List",
"example": {
"id": "123X"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
},
"x-examples": [
{
"id": "123X"
}
]
}
List2
{
"type": "object",
"title": "List2",
"example": {
"id": "1752X",
"name": "Shared with me",
"access": false
},
"required": [
"id",
"name",
"access"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "1752X",
"name": "Shared with me",
"access": false
}
]
}
List3
{
"type": "object",
"title": "List3",
"example": {
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
},
"required": [
"id",
"name",
"orderindex",
"status",
"priority",
"assignee",
"task_count",
"due_date",
"start_date",
"archived",
"override_statuses",
"statuses",
"permission_level"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": [
"string",
"null"
]
},
"archived": {
"type": "boolean"
},
"assignee": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"priority": {
"type": [
"string",
"null"
]
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Status"
},
"description": ""
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"start_date": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": "string"
},
"permission_level": {
"type": "string"
},
"override_statuses": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
]
}
List4
{
"type": "object",
"title": "List4",
"example": {
"id": "124X",
"name": "Updated 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": "Updated List Content",
"archived": false,
"assignee": null,
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "high"
},
"orderindex": 1,
"start_date": null,
"task_count": null,
"permission_level": "create",
"override_statuses": false
},
"required": [
"id",
"name",
"orderindex",
"content",
"status",
"priority",
"assignee",
"task_count",
"due_date",
"start_date",
"folder",
"space",
"archived",
"override_statuses",
"permission_level"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"space": {
"$ref": "#/components/schemas/Space2"
},
"folder": {
"$ref": "#/components/schemas/Folder3"
},
"status": {
"oneOf": [
{
"$ref": "#/components/schemas/Status11"
},
{
"type": [
"string",
"null"
]
},
{}
],
"example": {
"color": "#e50000",
"status": "red",
"hide_label": true
},
"x-examples": [
{
"color": "#e50000",
"status": "red",
"hide_label": true
}
]
},
"content": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"assignee": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"priority": {
"oneOf": [
{
"$ref": "#/components/schemas/Priority4"
},
{
"type": [
"string",
"null"
]
},
{}
],
"example": {
"color": "#f50000",
"priority": "high"
},
"x-examples": [
{
"color": "#f50000",
"priority": "high"
}
]
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"start_date": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": [
"string",
"null"
]
},
"permission_level": {
"type": "string"
},
"override_statuses": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "124X",
"name": "Updated 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": "Updated List Content",
"archived": false,
"assignee": null,
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "high"
},
"orderindex": 1,
"start_date": null,
"task_count": null,
"permission_level": "create",
"override_statuses": false
}
]
}
List6
{
"type": "object",
"title": "List6",
"example": {
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
},
"required": [
"id",
"name",
"orderindex",
"content",
"status",
"priority",
"assignee",
"task_count",
"due_date",
"start_date",
"archived"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": [
"string",
"null"
]
},
"content": {
"type": [
"string",
"null"
]
},
"archived": {
"type": "boolean"
},
"assignee": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"priority": {
"type": [
"string",
"null"
]
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"start_date": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": "string"
}
},
"x-examples": [
{
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
}
]
}
ListsAddTaskToListResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
ListsRemoveListResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
ListsRemoveTaskFromListResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
Member
{
"type": "object",
"title": "Member",
"example": {
"user": {
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
},
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User"
}
},
"x-examples": [
{
"user": {
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
}
]
}
Member1
{
"type": "object",
"title": "Member1",
"example": {
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
},
"required": [
"id",
"username",
"email",
"color",
"permission_level",
"profilePicture",
"initials",
"isCreator"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"isCreator": {
"type": "boolean"
},
"profilePicture": {
"type": "string"
},
"permission_level": {
"type": "string"
}
},
"x-examples": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
]
}
Member2
{
"type": "object",
"title": "Member2",
"example": {
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"added_by": 183,
"initials": "JD",
"username": "Jane Doe",
"date_added": 1631599941928,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "read"
},
"required": [
"id",
"email",
"username",
"color",
"permission_level",
"date_added",
"added_by",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"added_by": {
"type": "integer",
"contentEncoding": "int32"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"date_added": {
"type": "integer",
"contentEncoding": "int64"
},
"profilePicture": {
"type": "string"
},
"permission_level": {
"type": "string"
}
},
"x-examples": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"added_by": 183,
"initials": "JD",
"username": "Jane Doe",
"date_added": 1631599941928,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "read"
}
]
}
Member4
{
"type": "object",
"title": "Member4",
"example": {
"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": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"can_create_views"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User5"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
},
"can_edit_tags": {
"type": "boolean"
},
"can_create_views": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
}
},
"x-examples": [
{
"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
}
]
}
Member5
{
"type": "object",
"title": "Member5",
"example": {
"id": 812,
"color": "#FFFFFF",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg"
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture",
"profileInfo"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profileInfo": {
"$ref": "#/components/schemas/ProfileInfo"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 812,
"color": "#FFFFFF",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg"
}
]
}
Member7
{
"type": "object",
"title": "Member7",
"example": {
"user": {
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "UN",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
},
"properties": {
"user": {
"$ref": "#/components/schemas/User21"
},
"shared": {
"$ref": "#/components/schemas/Shared"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
}
},
"x-examples": [
{
"user": {
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "UN",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
}
]
}
Members
{
"type": "object",
"title": "Members",
"example": {
"empty_member_seats": 0,
"total_member_seats": 9,
"filled_members_seats": 9
},
"required": [
"filled_members_seats",
"total_member_seats",
"empty_member_seats"
],
"properties": {
"empty_member_seats": {
"type": "integer",
"contentEncoding": "int32"
},
"total_member_seats": {
"type": "integer",
"contentEncoding": "int32"
},
"filled_members_seats": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"empty_member_seats": 0,
"total_member_seats": 9,
"filled_members_seats": 9
}
]
}
Members1
{
"type": "object",
"title": "Members1",
"example": {
"id": 185,
"color": "#4169E1",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 185,
"color": "#4169E1",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
]
}
Members2
{
"type": "object",
"title": "Members2",
"example": {
"add": [
123456,
987654
],
"rem": [
159753
]
},
"required": [
"add",
"rem"
],
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"rem": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"x-examples": [
{
"add": [
123456,
987654
],
"rem": [
159753
]
}
]
}
Members3
{
"type": "object",
"title": "Members3",
"example": {
"id": 201,
"color": "#40BC86",
"email": "jim@example.com",
"initials": "JH",
"username": "Jim Halpert",
"profilePicture": null
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": 201,
"color": "#40BC86",
"email": "jim@example.com",
"initials": "JH",
"username": "Jim Halpert",
"profilePicture": null
}
]
}
Members5
{
"type": "object",
"title": "Members5",
"example": {
"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": [
"user",
"invited_by"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User5"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
}
},
"x-examples": [
{
"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"
}
}
]
}
Milestones
{
"type": "object",
"title": "Milestones",
"example": {
"enabled": false
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": false
}
]
}
MultipleAssignees
{
"type": "object",
"title": "MultipleAssignees",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
Option
{
"type": "object",
"title": "Option",
"example": {
"id": "fb332c98-d7bc-4ee8-a3bd-b5ffaff98c3c",
"color": null,
"label": "one"
},
"required": [
"id",
"color"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"color": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"value": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": "fb332c98-d7bc-4ee8-a3bd-b5ffaff98c3c",
"color": null,
"label": "one"
}
]
}
Owner
{
"type": "object",
"title": "Owner",
"example": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"required": [
"id",
"username",
"initials",
"email",
"color",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
}
Parent
{
"type": "object",
"title": "Parent",
"example": {
"id": "512X",
"type": 7
},
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "The id of the Workspace, Space, Folder, or List where the view is located."
},
"type": {
"type": "integer",
"description": "The level of the Hierarchy where the view is created. \\\n \\\nOptions include: \\\n \\\nWorkspace (Everything Level): `7` \\\n \\\nSpace: `4` \\\n \\\nFolder: `5` \\\n \\\nList: `6`",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": "512X",
"type": 7
}
],
"description": "The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\n \\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\n \\\nThe `type` value indciates the level of the Hierarchy where the view is located."
}
Points
{
"type": "object",
"title": "Points",
"example": {
"enabled": false
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": false
}
]
}
Portfolios
{
"type": "object",
"title": "Portfolios",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
Priority
{
"type": "object",
"title": "Priority",
"example": {
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
},
"required": [
"id",
"priority",
"color",
"orderindex"
],
"properties": {
"id": {
"type": "string"
},
"color": {
"type": "string"
},
"priority": {
"type": "string"
},
"orderindex": {
"type": "string"
}
},
"x-examples": [
{
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
}
]
}
Priority1
{
"type": "object",
"title": "Priority1",
"example": {
"color": "#f50000",
"priority": "urgent"
},
"required": [
"priority",
"color"
],
"properties": {
"color": {
"type": "string"
},
"priority": {
"type": "string"
}
},
"x-examples": [
{
"color": "#f50000",
"priority": "urgent"
}
]
}
Priority4
{
"type": "object",
"title": "Priority4",
"example": {
"color": "#f50000",
"priority": "high"
},
"properties": {
"color": {
"type": "string"
},
"priority": {
"type": "string"
}
},
"x-examples": [
{
"color": "#f50000",
"priority": "high"
}
]
}
ProfileInfo
{
"type": "object",
"title": "ProfileInfo",
"example": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"required": [
"display_profile",
"verified_ambassador",
"verified_consultant",
"top_tier_user",
"viewed_verified_ambassador",
"viewed_verified_consultant",
"viewed_top_tier_user"
],
"properties": {
"top_tier_user": {
"type": [
"string",
"null"
]
},
"display_profile": {
"type": [
"string",
"null"
]
},
"verified_ambassador": {
"type": [
"string",
"null"
]
},
"verified_consultant": {
"type": [
"string",
"null"
]
},
"viewed_top_tier_user": {
"type": [
"string",
"null"
]
},
"viewed_verified_ambassador": {
"type": [
"string",
"null"
]
},
"viewed_verified_consultant": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
}
]
}
Project
{
"type": "object",
"title": "Project",
"example": {
"id": "1X",
"name": "Folder",
"access": true,
"hidden": false
},
"required": [
"id",
"name",
"hidden",
"access"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "1X",
"name": "Folder",
"access": true,
"hidden": false
}
]
}
RemapDependencies
{
"type": "object",
"title": "RemapDependencies",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
RemoveGuestFromFolderresponse
{
"type": "object",
"title": "RemoveGuestFromFolderresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest2"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
RemoveGuestFromListresponse
{
"type": "object",
"title": "RemoveGuestFromListresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest2"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
RemoveGuestFromTaskresponse
{
"type": "object",
"title": "RemoveGuestFromTaskresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest2"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"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_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
RemoveGuestFromWorkspaceresponse
{
"type": "object",
"title": "RemoveGuestFromWorkspaceresponse",
"example": {
"team": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
},
"required": [
"team"
],
"properties": {
"team": {
"$ref": "#/components/schemas/Team2"
}
},
"x-examples": [
{
"team": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
}
]
}
RemoveUserFromWorkspaceresponse
{
"type": "object",
"title": "RemoveUserFromWorkspaceresponse",
"example": {
"team": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
},
"required": [
"team"
],
"properties": {
"team": {
"$ref": "#/components/schemas/Team2"
}
},
"x-examples": [
{
"team": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
}
]
}
Removetagsfromtimeentriesrequest
{
"type": "object",
"title": "Removetagsfromtimeentriesrequest",
"example": {
"tags": [
{
"name": "name of tag"
}
],
"time_entry_ids": [
"timer_id"
]
},
"required": [
"time_entry_ids",
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags10"
},
"description": ""
},
"time_entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"tags": [
{
"name": "name of tag"
}
],
"time_entry_ids": [
"timer_id"
]
}
]
}
Role
{
"type": "object",
"title": "Role",
"example": {
"id": 1,
"name": "owner",
"custom": false
},
"required": [
"id",
"name",
"custom"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"name": {
"type": "string"
},
"custom": {
"type": "boolean"
},
"inherited_role": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": 1,
"name": "owner",
"custom": false
}
]
}
SetCustomFieldValuerequest
{
"anyOf": [
{
"type": "object",
"title": "URL Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "https://clickup.com/api"
}
},
"description": "The `value` must be a string with a valid URL."
},
{
"type": "object",
"title": "Dropdown Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "uuid1234"
}
},
"description": "Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Email Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "user@company.com"
}
},
"description": "The `value` must be a string with a valid email address."
},
{
"type": "object",
"title": "Phone Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "+1 123 456 7890"
}
},
"description": "The `value` must be a string with a valid country code."
},
{
"type": "object",
"title": "Date Custom Field",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"example": 1667367645000
},
"value_options": {
"type": "object",
"required": [
"time"
],
"properties": {
"time": {
"type": "boolean",
"example": true
}
}
}
},
"description": "The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property."
},
{
"type": "object",
"title": "Short or Long Text Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "This is short or long text in a Custom Field."
}
},
"description": "Enter a string of text."
},
{
"type": "object",
"title": "Number Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "number",
"example": -28
}
},
"description": "Enter a number."
},
{
"type": "object",
"title": "Money Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "number",
"example": 8000
}
},
"description": "You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Task Relationship Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
}
},
"rem": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"description": "Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship."
},
{
"type": "object",
"title": "People Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "number"
}
},
"rem": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
},
"description": "Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](https://clickup.com/api)"
},
{
"type": "object",
"title": "Emoji (Rating) Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "integer",
"format": "int32",
"example": 4
}
},
"description": "Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Manual Progress Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"required": [
"current"
],
"properties": {
"current": {
"type": "number",
"example": 20
}
}
}
},
"description": "Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Label Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"uuid1234",
"uuid9876"
]
}
}
},
"description": "Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Location Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"lng": {
"type": "number"
}
}
},
"formatted_address": {
"type": "string"
}
}
}
},
"description": "Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)"
}
],
"title": "SetCustomFieldValuerequest"
}
Settings
{
"type": "object",
"title": "Settings",
"example": {
"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
},
"required": [
"show_task_locations",
"show_subtasks",
"show_subtask_parent_names",
"show_closed_subtasks",
"show_assignees",
"show_images",
"collapse_empty_columns",
"me_comments",
"me_subtasks",
"me_checklists"
],
"properties": {
"me_comments": {
"type": "boolean"
},
"me_subtasks": {
"type": "boolean"
},
"show_images": {
"type": "boolean"
},
"me_checklists": {
"type": "boolean"
},
"show_subtasks": {
"type": "integer",
"description": "Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.",
"contentEncoding": "int32"
},
"show_assignees": {
"type": "boolean"
},
"show_task_locations": {
"type": "boolean"
},
"show_closed_subtasks": {
"type": "boolean"
},
"collapse_empty_columns": {
"type": [
"string",
"null"
]
},
"show_subtask_parent_names": {
"type": "boolean"
}
},
"x-examples": [
{
"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
}
]
}
Shared
{
"type": "object",
"title": "Shared",
"example": {
"lists": [],
"tasks": [],
"folders": []
},
"properties": {
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"lists": [],
"tasks": [],
"folders": []
}
]
}
Shared1
{
"type": "object",
"title": "Shared1",
"example": {
"lists": [],
"tasks": [
{
"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"
}
],
"folders": []
},
"required": [
"tasks",
"lists",
"folders"
],
"properties": {
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task2"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"lists": [],
"tasks": [
{
"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"
}
],
"folders": []
}
]
}
Shared3
{
"type": "object",
"title": "Shared3",
"example": {
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
},
"required": [
"tasks",
"lists",
"folders"
],
"properties": {
"lists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/List3"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
}
]
}
Shared5
{
"type": "object",
"title": "Shared5",
"example": {
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
},
"required": [
"tasks",
"lists",
"folders"
],
"properties": {
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Folder4"
},
"description": ""
}
},
"x-examples": [
{
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
}
]
}
Shared7
{
"type": "object",
"title": "Shared7",
"example": {
"lists": [
{
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
}
],
"tasks": [],
"folders": [
{
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
}
]
},
"required": [
"tasks",
"lists",
"folders"
],
"properties": {
"lists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/List6"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Folder11"
},
"description": ""
}
},
"x-examples": [
{
"lists": [
{
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
}
],
"tasks": [],
"folders": [
{
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
}
]
}
]
}
SharedHierarchyresponse
{
"type": "object",
"title": "SharedHierarchyresponse",
"example": {
"shared": {
"lists": [
{
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
}
],
"tasks": [],
"folders": [
{
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
}
]
}
},
"required": [
"shared"
],
"properties": {
"shared": {
"$ref": "#/components/schemas/Shared7"
}
},
"x-examples": [
{
"shared": {
"lists": [
{
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
}
],
"tasks": [],
"folders": [
{
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
}
]
}
}
]
}
Sorting
{
"type": "object",
"title": "Sorting",
"example": {
"fields": [
{
"dir": -1,
"idx": 0,
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2"
}
]
},
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](https://clickup.com/api)."
}
},
"x-examples": [
{
"fields": [
{
"dir": -1,
"idx": 0,
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2"
}
]
}
]
}
Space
{
"type": "object",
"title": "Space",
"example": {
"id": "789X"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
},
"x-examples": [
{
"id": "789X"
}
]
}
Space13
{
"type": "object",
"title": "Space13",
"example": {
"id": "790X",
"name": "Updated Space Name",
"color": null,
"avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"members": [
{
"user": {
"id": 12312312,
"color": null,
"initials": "JJ",
"username": "John Jones",
"profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg"
}
}
],
"private": false,
"archived": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"admin_can_manage": true,
"multiple_assignees": false
},
"required": [
"id",
"name",
"private",
"statuses",
"multiple_assignees",
"features"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"avatar": {
"type": "string"
},
"members": {
"type": "array",
"user": {
"id": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"items": {
"$ref": "#/components/schemas/Member"
},
"description": ""
},
"private": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"features": {
"$ref": "#/components/schemas/Features4"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Status"
},
"description": ""
},
"admin_can_manage": {
"type": "boolean"
},
"multiple_assignees": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "790X",
"name": "Updated Space Name",
"color": null,
"avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"members": [
{
"user": {
"id": 12312312,
"color": null,
"initials": "JJ",
"username": "John Jones",
"profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg"
}
}
],
"private": false,
"archived": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"admin_can_manage": true,
"multiple_assignees": false
}
]
}
Space2
{
"type": "object",
"title": "Space2",
"example": {
"id": "789X",
"name": "Space Name",
"access": true
},
"required": [
"id",
"name",
"access"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "789X",
"name": "Space Name",
"access": true
}
]
}
SpacesRemoveSpaceResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
Sprints
{
"type": "object",
"title": "Sprints",
"example": {
"enabled": false
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": false
}
]
}
StartatimeEntryrequest
{
"type": "object",
"title": "StartatimeEntryrequest",
"example": {
"tid": "task_id",
"tags": [
{
"name": "tag1"
}
],
"billable": false,
"description": "from api"
},
"properties": {
"tid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags10"
},
"description": "Users on the Business Plan and above can include a time tracking label."
},
"billable": {
"type": "boolean"
},
"description": {
"type": "string"
}
},
"x-examples": [
{
"tid": "task_id",
"tags": [
{
"name": "tag1"
}
],
"billable": false,
"description": "from api"
}
]
}
StartatimeEntryresponse
{
"type": "object",
"title": "StartatimeEntryresponse",
"example": {
"data": {
"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": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Data2"
}
},
"x-examples": [
{
"data": {
"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": ""
}
}
]
}
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
}
]
}
Tracktimeresponse
{
"type": "object",
"title": "Tracktimeresponse",
"example": {
"id": "123X"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
},
"x-examples": [
{
"id": "123X"
}
]
}
TypeConfig
{
"type": "object",
"title": "TypeConfig",
"example": {},
"properties": {
"end": {
"type": "integer",
"contentEncoding": "int32"
},
"count": {
"type": "integer",
"contentEncoding": "int32"
},
"start": {
"type": "integer",
"contentEncoding": "int32"
},
"default": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": "integer",
"contentEncoding": "int32"
},
{}
]
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Option"
},
"description": ""
},
"tracking": {
"$ref": "#/components/schemas/Tracking"
},
"precision": {
"type": "integer",
"contentEncoding": "int32"
},
"code_point": {
"type": "string"
},
"complete_on": {
"type": "integer",
"contentEncoding": "int32"
},
"placeholder": {
"type": [
"string",
"null"
]
},
"currency_type": {
"type": "string"
}
},
"x-examples": [
{}
]
}
TypeConfig1
{
"type": "object",
"title": "TypeConfig1",
"example": {},
"properties": {
"single_user": {
"type": "boolean"
},
"include_groups": {
"type": "boolean"
},
"include_guests": {
"type": "boolean"
},
"include_team_members": {
"type": "boolean"
}
},
"x-examples": [
{}
]
}
UpdateCommentrequest
{
"type": "object",
"title": "UpdateCommentrequest",
"example": {
"assignee": 183,
"resolved": true,
"comment_text": "Updated comment content"
},
"required": [
"comment_text",
"assignee",
"resolved"
],
"properties": {
"assignee": {
"type": "integer",
"contentEncoding": "int32"
},
"resolved": {
"type": "boolean",
"description": ""
},
"comment_text": {
"type": "string"
}
},
"x-examples": [
{
"assignee": 183,
"resolved": true,
"comment_text": "Updated comment content"
}
]
}
UpdateFolderrequest
{
"type": "object",
"title": "UpdateFolderrequest",
"example": {
"name": "Updated Folder Name"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
},
"x-examples": [
{
"name": "Updated Folder Name"
}
]
}
UpdateFolderresponse
{
"type": "object",
"title": "UpdateFolderresponse",
"example": {
"id": "457X",
"name": "Updated Folder Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
},
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"space",
"task_count"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"space": {
"$ref": "#/components/schemas/Space2"
},
"hidden": {
"type": "boolean"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"task_count": {
"type": "string"
},
"override_statuses": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "457X",
"name": "Updated Folder Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
}
]
}
UpdateGoalrequest
{
"type": "object",
"title": "UpdateGoalrequest",
"example": {
"name": "Updated Goal Name",
"color": "#32a852",
"due_date": 1568036964079,
"add_owners": [
184
],
"rem_owners": [
183
],
"description": "Updated Goal Description"
},
"required": [
"name",
"due_date",
"description",
"rem_owners",
"add_owners",
"color"
],
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"add_owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": "Array of user IDs."
},
"rem_owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": "Array of user IDs."
},
"description": {
"type": "string"
}
},
"x-examples": [
{
"name": "Updated Goal Name",
"color": "#32a852",
"due_date": 1568036964079,
"add_owners": [
184
],
"rem_owners": [
183
],
"description": "Updated Goal Description"
}
]
}
UpdateGoalresponse
{
"type": "object",
"title": "UpdateGoalresponse",
"example": {
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Updated Goal Name",
"color": "#32a852",
"owners": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Updated Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
}
},
"required": [
"goal"
],
"properties": {
"goal": {
"$ref": "#/components/schemas/Goal"
}
},
"x-examples": [
{
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Updated Goal Name",
"color": "#32a852",
"owners": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Updated Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
}
}
]
}
UpdateListrequest
{
"type": "object",
"title": "UpdateListrequest",
"example": {
"name": "Updated List Name",
"status": "red",
"content": "Updated List Content",
"assignee": "none",
"due_date": 1567780450202,
"priority": 2,
"unset_status": true,
"due_date_time": true
},
"required": [
"name",
"content",
"due_date",
"due_date_time",
"priority",
"assignee",
"status",
"unset_status"
],
"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": "string"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"unset_status": {
"type": "boolean",
"description": "By default, this is `false.` To remove the List color use `unset_status: true`."
},
"due_date_time": {
"type": "boolean"
}
},
"x-examples": [
{
"name": "Updated List Name",
"status": "red",
"content": "Updated List Content",
"assignee": "none",
"due_date": 1567780450202,
"priority": 2,
"unset_status": true,
"due_date_time": true
}
]
}
UpdateListresponse
{
"type": "object",
"title": "UpdateListresponse",
"example": {
"id": "124X",
"name": "Updated 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": "Updated List Content",
"assignee": null,
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "high"
},
"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": true,
"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": {
"type": [
"string",
"null"
]
},
"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": "Updated 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": "Updated List Content",
"assignee": null,
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "high"
},
"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": true,
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
"start_date_time": null
}
]
}
UpdateSpacerequest
{
"type": "object",
"title": "UpdateSpacerequest",
"example": {
"name": "Updated Space Name",
"color": "#7B68EE",
"private": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"admin_can_manage": false,
"multiple_assignees": false
},
"required": [
"name",
"color",
"private",
"admin_can_manage",
"multiple_assignees",
"features"
],
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"private": {
"type": "boolean"
},
"features": {
"$ref": "#/components/schemas/Features"
},
"admin_can_manage": {
"type": "boolean",
"description": "***Note:** Allowing or restricting admins from managing private Spaces using `\"admin_can_manage\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*"
},
"multiple_assignees": {
"type": "boolean"
}
},
"x-examples": [
{
"name": "Updated Space Name",
"color": "#7B68EE",
"private": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"admin_can_manage": false,
"multiple_assignees": false
}
]
}
UpdateSpaceresponse
{
"type": "object",
"title": "UpdateSpaceresponse",
"example": {
"id": "790X",
"name": "Updated Space Name",
"private": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"multiple_assignees": false
},
"required": [
"id",
"name",
"private",
"statuses",
"multiple_assignees",
"features"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"features": {
"$ref": "#/components/schemas/Features"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Status"
},
"description": ""
},
"multiple_assignees": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "790X",
"name": "Updated Space Name",
"private": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"multiple_assignees": false
}
]
}
UpdateTaskrequest
{
"type": "object",
"title": "UpdateTaskrequest",
"example": {
"name": "Updated Task Name",
"parent": "abc1234",
"status": "in progress",
"archived": false,
"due_date": 1508369194377,
"priority": 1,
"watchers": {
"add": [
182
],
"rem": [
183
]
},
"assignees": {
"add": [
182
],
"rem": [
183
]
},
"start_date": 1567780450202,
"description": "Updated Task Content",
"due_date_time": false,
"time_estimate": 8640000,
"start_date_time": false
},
"properties": {
"name": {
"type": "string"
},
"parent": {
"type": "string",
"description": "You can move a subtask to another parent task by including `\"parent\"` with a valid `task id`.\\\n \\\nYou cannot convert a subtask to a task by setting `\"parent\"` to `null`."
},
"status": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"watchers": {
"$ref": "#/components/schemas/Watchers"
},
"assignees": {
"$ref": "#/components/schemas/Assignees"
},
"start_date": {
"type": "integer",
"contentEncoding": "int64"
},
"description": {
"type": "string",
"description": "To clear the task description, include `Description` with `\" \"`."
},
"due_date_time": {
"type": "boolean"
},
"time_estimate": {
"type": "integer",
"contentEncoding": "int32"
},
"custom_item_id": {
"type": [
"number",
"null"
],
"description": "To convert an item using a custom task type into a task, send `'null'`. \\\n \\\nTo update this task to be 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"
}
},
"x-examples": [
{
"name": "Updated Task Name",
"parent": "abc1234",
"status": "in progress",
"archived": false,
"due_date": 1508369194377,
"priority": 1,
"watchers": {
"add": [
182
],
"rem": [
183
]
},
"assignees": {
"add": [
182
],
"rem": [
183
]
},
"start_date": 1567780450202,
"description": "Updated Task Content",
"due_date_time": false,
"time_estimate": 8640000,
"start_date_time": false
}
]
}
UpdateTaskresponse
{
"type": "object",
"title": "UpdateTaskresponse",
"example": {
"id": "9hxX",
"url": "https://app.clickup.com/t/9hx",
"list": {
"id": "123X"
},
"name": "Updated Task Name",
"tags": [],
"space": {
"id": "789X"
},
"folder": {
"id": "456X"
},
"parent": "abc1234",
"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"
},
"archived": false,
"due_date": null,
"priority": null,
"assignees": [],
"custom_id": null,
"checklists": [],
"orderindex": "1.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"description": "Updated Task Content",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"text_content": "Updated Task Content",
"custom_fields": [
{
"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
},
{
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5X",
"name": "My Text field",
"type": "short_text",
"value": "Text field input",
"required": false,
"type_config": {},
"date_created": "1622176979540",
"hide_from_guests": false
},
{
"id": "f4d2a20d-6759-4420-b853-222dbe2589d5X",
"name": "My People",
"type": "users",
"required": false,
"type_config": {
"single_user": true,
"include_groups": true,
"include_guests": true,
"include_team_members": true
},
"date_created": "1618440378816",
"hide_from_guests": false
}
],
"time_estimate": null
},
"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"
},
"status": {
"$ref": "#/components/schemas/Status"
},
"creator": {
"$ref": "#/components/schemas/Creator"
},
"archived": {
"type": "boolean"
},
"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/CustomFields7"
},
"description": ""
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"custom_item_id": {
"type": [
"number",
"null"
]
}
},
"x-examples": [
{
"id": "9hxX",
"url": "https://app.clickup.com/t/9hx",
"list": {
"id": "123X"
},
"name": "Updated Task Name",
"tags": [],
"space": {
"id": "789X"
},
"folder": {
"id": "456X"
},
"parent": "abc1234",
"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"
},
"archived": false,
"due_date": null,
"priority": null,
"assignees": [],
"custom_id": null,
"checklists": [],
"orderindex": "1.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"description": "Updated Task Content",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"text_content": "Updated Task Content",
"custom_fields": [
{
"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
},
{
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5X",
"name": "My Text field",
"type": "short_text",
"value": "Text field input",
"required": false,
"type_config": {},
"date_created": "1622176979540",
"hide_from_guests": false
},
{
"id": "f4d2a20d-6759-4420-b853-222dbe2589d5X",
"name": "My People",
"type": "users",
"required": false,
"type_config": {
"single_user": true,
"include_groups": true,
"include_guests": true,
"include_team_members": true
},
"date_created": "1618440378816",
"hide_from_guests": false
}
],
"time_estimate": null
}
]
}
UpdateTeamrequest
{
"type": "object",
"title": "UpdateTeamrequest",
"example": {
"name": "New User Group Name",
"handle": "newusergroupname",
"members": {
"add": [
123456,
987654
],
"rem": [
159753
]
}
},
"properties": {
"name": {
"type": "string"
},
"handle": {
"type": "string"
},
"members": {
"$ref": "#/components/schemas/Members2"
}
},
"x-examples": [
{
"name": "New User Group Name",
"handle": "newusergroupname",
"members": {
"add": [
123456,
987654
],
"rem": [
159753
]
}
}
]
}
UpdateTeamresponse
{
"type": "object",
"title": "UpdateTeamresponse",
"example": {
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870dX",
"name": "New User Group Name",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "newusergroupname",
"userid": 301828,
"members": [
{
"id": 201,
"color": "#40BC86",
"email": "jim@example.com",
"initials": "JH",
"username": "Jim Halpert",
"profilePicture": null
},
{
"id": 202,
"color": "#FF8600",
"email": "dwight@example.com",
"initials": "DS",
"username": "Dwight Shrute",
"profilePicture": null
}
],
"team_id": "123456",
"initials": "NN",
"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/Members3"
},
"description": ""
},
"team_id": {
"type": "string"
},
"initials": {
"type": "string"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870dX",
"name": "New User Group Name",
"avatar": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"handle": "newusergroupname",
"userid": 301828,
"members": [
{
"id": 201,
"color": "#40BC86",
"email": "jim@example.com",
"initials": "JH",
"username": "Jim Halpert",
"profilePicture": null
},
{
"id": 202,
"color": "#FF8600",
"email": "dwight@example.com",
"initials": "DS",
"username": "Dwight Shrute",
"profilePicture": null
}
],
"team_id": "123456",
"initials": "NN",
"date_created": "1640122639829"
}
]
}
UpdateViewrequest
{
"type": "object",
"title": "UpdateViewrequest",
"example": {
"name": "New 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": [
"name",
"type",
"parent",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"divide": {
"$ref": "#/components/schemas/Divide"
},
"parent": {
"$ref": "#/components/schemas/Parent"
},
"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 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
}
}
]
}
UpdateViewresponse
{
"type": "object",
"title": "UpdateViewresponse",
"example": {
"view": {
"id": "3c-105X",
"name": "New 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 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
}
}
}
]
}
UpdateWebhookrequest
{
"type": "object",
"title": "UpdateWebhookrequest",
"example": {
"events": "*",
"status": "active",
"endpoint": "https://yourdomain.com/webhook"
},
"required": [
"endpoint",
"events",
"status"
],
"properties": {
"events": {
"type": "string"
},
"status": {
"type": "string"
},
"endpoint": {
"type": "string"
}
},
"x-examples": [
{
"events": "*",
"status": "active",
"endpoint": "https://yourdomain.com/webhook"
}
]
}
UpdateWebhookresponse
{
"type": "object",
"title": "UpdateWebhookresponse",
"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
}
}
]
}
UpdateatimeEntryrequest
{
"type": "object",
"title": "UpdateatimeEntryrequest",
"example": {
"end": 1595289495842,
"tid": "task_id",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"start": 1595289395842,
"billable": true,
"duration": 100000,
"tag_action": "add",
"description": ""
},
"required": [
"tags"
],
"properties": {
"end": {
"type": "integer",
"description": "When providing `end`, you must also provide `start`.",
"contentEncoding": "int64"
},
"tid": {
"type": "string"
},
"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",
"description": "When providing `start`, you must also provide `end`.",
"contentEncoding": "int64"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
},
"tag_action": {
"type": "string"
},
"description": {
"type": "string"
}
},
"x-examples": [
{
"end": 1595289495842,
"tid": "task_id",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"start": 1595289395842,
"billable": true,
"duration": 100000,
"tag_action": "add",
"description": ""
}
]
}
User
{
"type": "object",
"title": "User",
"example": {
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
},
"required": [
"id",
"username",
"color",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
]
}
User13
{
"type": "object",
"title": "User13",
"example": {
"id": 1,
"color": "#795548",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": null
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": 1,
"color": "#795548",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": null
}
]
}
User2
{
"type": "object",
"title": "User2",
"example": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"required": [
"id",
"username",
"initials",
"email",
"color",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
}
User21
{
"type": "object",
"title": "User21",
"example": {
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "G",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"role": {
"type": "integer",
"description": "Owner = 1, Admin = 2, Member = 3, Guest = 4",
"contentEncoding": "int32"
},
"color": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"custom_role": {
"$ref": "#/components/schemas/CustomRole"
},
"date_joined": {
"type": [
"string",
"null"
]
},
"last_active": {
"type": [
"string",
"null"
]
},
"date_invited": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "G",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
}
]
}
User5
{
"type": "object",
"title": "User5",
"example": {
"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
},
"required": [
"id",
"username",
"email",
"color",
"profilePicture",
"initials",
"role",
"custom_role",
"last_active",
"date_joined",
"date_invited"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"role": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": [
"string",
"null"
]
},
"custom_role": {
"$ref": "#/components/schemas/CustomRole"
},
"date_joined": {
"type": [
"string",
"null"
]
},
"last_active": {
"type": [
"string",
"null"
]
},
"date_invited": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"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
}
]
}
User7
{
"type": "object",
"title": "User7",
"example": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"required": [
"id",
"username",
"email",
"color",
"profilePicture",
"initials",
"role",
"last_active",
"date_joined",
"date_invited"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"role": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": [
"string",
"null"
]
},
"date_joined": {
"type": [
"string",
"null"
]
},
"last_active": {
"type": [
"string",
"null"
]
},
"date_invited": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
}
]
}
Value
{
"type": "object",
"title": "Value",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
}
}
Value1
{
"type": "object",
"title": "Value1",
"example": {
"id": 183,
"color": "#7b68ee",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": null
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": 183,
"color": "#7b68ee",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": null
}
]
}
Value2
{
"type": "object",
"title": "Value2",
"example": [
"This is a text CF"
],
"required": [
"value"
],
"properties": {
"value": {
"type": "string"
}
}
}
View
{
"type": "object",
"title": "View",
"example": {
"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": {
"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": [
"id",
"name",
"type",
"parent",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"divide": {
"$ref": "#/components/schemas/Divide"
},
"parent": {
"$ref": "#/components/schemas/Parent"
},
"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": [
{
"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": {
"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
}
}
]
}
ViewsDeleteViewByIdResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
Watchers
{
"type": "object",
"title": "Watchers",
"example": {
"add": [
182,
121
],
"rem": [
183,
122
]
},
"required": [
"add",
"rem"
],
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"rem": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"x-examples": [
{
"add": [
182,
121
],
"rem": [
183,
122
]
}
]
}
Watchers1
{
"type": "object",
"title": "Watchers1",
"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"
}
]
}
Webhook
{
"type": "object",
"title": "Webhook",
"example": {
"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",
"userid",
"team_id",
"endpoint",
"client_id",
"events",
"task_id",
"list_id",
"folder_id",
"space_id",
"health",
"secret"
],
"properties": {
"id": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"health": {
"$ref": "#/components/schemas/Health"
},
"secret": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"list_id": {
"type": [
"string",
"null"
]
},
"task_id": {
"type": [
"string",
"null"
]
},
"team_id": {
"type": "integer",
"contentEncoding": "int32"
},
"endpoint": {
"type": "string"
},
"space_id": {
"type": [
"string",
"null"
]
},
"client_id": {
"type": "string"
},
"folder_id": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"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
}
]
}
WebhooksRemoveWebhookByIdResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
Zoom
{
"type": "object",
"title": "Zoom",
"example": {
"enabled": false
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": false
}
]
}