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