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"
}
]
}