ClickUp

Project management and productivity platform

clickup.com/api ↗

Version

2.0

OpenAPI

3.0.3

Endpoints

126

Schemas

337

82

Quality

Updated

3 days ago

Productivity productivity project-management tasks

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.clickup.com/api/v2

https://a00fb6e0-339c-4201-972f-503b9932d17a.remockly.com

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Comments 1 endpoints

DELETE /comment/{comment_id} Delete Comment

Delete a task comment.

operationId: Comments_deleteTaskComment

Parameters

Name	In	Required	Type	Description
comment_id	path	required	number	—

Responses

200 —

DELETE /comment/{comment_id}

Customfields 1 endpoints

DELETE /task/{task_id}/field/{field_id} Remove Custom Field Value

Remove the data from a Custom Field on a task. This does not delete the option from the Custom Field.

operationId: CustomFields_removeFieldValue

Parameters

Name	In	Required	Type	Description
task_id	path	required	string	—
field_id	path	required	string	b8a8-48d8-a0c6-b4200788a683 (uuid)
custom_task_ids	query	optional	boolean	If you want to reference a task by it’s custom task id, this value must be `true`.
team_id	query	optional	number	Only used when the `custom_task_ids` parameter is set to `true`.\ \ For example: `custom_task_ids=true&team_id=123`.

Responses

200 —

DELETE /task/{task_id}/field/{field_id}

Folders 1 endpoints

DELETE /folder/{folder_id} Delete Folder

Delete a Folder from your Workspace.

operationId: Folders_removeFolder

Parameters

Name	In	Required	Type	Description
folder_id	path	required	number	—

Responses

200 —

DELETE /folder/{folder_id}

Goals 2 endpoints

DELETE /goal/{goal_id} Delete Goal

Remove a Goal from your Workspace.

operationId: Goals_removeGoal

Parameters

Name	In	Required	Type	Description
goal_id	path	required	string	900e-462d-a849-4a216b06d930 (uuid)

Responses

200 —

DELETE /goal/{goal_id}

DELETE /key_result/{key_result_id} Delete Key Result

Delete a target from a Goal.

operationId: Goals_removeTarget

Parameters

Name	In	Required	Type	Description
key_result_id	path	required	string	8480-49bc-8c57-e569747efe93 (uuid)

Responses

200 —

DELETE /key_result/{key_result_id}

Guests 4 endpoints

DELETE /folder/{folder_id}/guest/{guest_id} Remove Guest From Folder

Revoke a guest’s access to a Folder. \
\
Note: This endpoint is only available to Workspaces on our Enterprise Plan.

operationId: Guests_revokeAccessFromFolder

Parameters

Name	In	Required	Type	Description
folder_id	path	required	number	—
guest_id	path	required	number	—
include_shared	query	optional	boolean	Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.

Responses

200 —

DELETE /folder/{folder_id}/guest/{guest_id}

DELETE /list/{list_id}/guest/{guest_id} Remove Guest From List

Revoke a guest’s access to a List.\
\
Note: This endpoint is only available to Workspaces on our Enterprise Plan.

operationId: Guests_removeFromList

Parameters

Name	In	Required	Type	Description
list_id	path	required	number	—
guest_id	path	required	number	—
include_shared	query	optional	boolean	Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.

Responses

200 —

DELETE /list/{list_id}/guest/{guest_id}

DELETE /task/{task_id}/guest/{guest_id} Remove Guest From Task

Revoke a guest’s access to a task. \
\
Note: This endpoint is only available to Workspaces on our Enterprise Plan.

operationId: Guests_revokeAccessToTask

Parameters

Name	In	Required	Type	Description
task_id	path	required	string	—
guest_id	path	required	number	—
include_shared	query	optional	boolean	Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.
custom_task_ids	query	optional	boolean	If you want to reference a task by it’s custom task id, this value must be `true`.
team_id	query	optional	number	Only used when the `custom_task_ids` parameter is set to `true`.\ \ For example: `custom_task_ids=true&team_id=123`.

Responses

200 —

DELETE /task/{task_id}/guest/{guest_id}

DELETE /team/{team_id}/guest/{guest_id} Remove Guest From Workspace

Revoke a guest’s access to a Workspace. \
\
Note: This endpoint is only available to Workspaces on our Enterprise Plan.

operationId: Guests_revokeGuestAccessToWorkspace

Parameters

Name	In	Required	Type	Description
team_id	path	required	number	Team ID (Workspace)
guest_id	path	required	number	—

Responses

200 —

DELETE /team/{team_id}/guest/{guest_id}

Lists 2 endpoints

DELETE /list/{list_id} Delete List

Delete a List from your Workspace.

operationId: Lists_removeList

Parameters

Name	In	Required	Type	Description
list_id	path	required	number	—

Responses

200 —

DELETE /list/{list_id}

DELETE /list/{list_id}/task/{task_id} Remove Task From List

Remove a task from an additional List. You can’t remove a task from its home List. \
\
Note: This endpoint requires the Tasks in Multiple List ClickApp to be enabled.

operationId: Lists_removeTaskFromList

Parameters

Name	In	Required	Type	Description
list_id	path	required	number	—
task_id	path	required	string	—

Responses

200 —

DELETE /list/{list_id}/task/{task_id}

Spaces 1 endpoints

DELETE /space/{space_id} Delete Space

Delete a Space from your Workspace.

operationId: Spaces_removeSpace

Parameters

Name	In	Required	Type	Description
space_id	path	required	number	—

Responses

200 —

DELETE /space/{space_id}

Tags 2 endpoints

DELETE /space/{space_id}/tag/{tag_name} Delete Space Tag

Delete a task Tag from a Space.

operationId: Tags_removeSpaceTag

Parameters

Name	In	Required	Type	Description
space_id	path	required	number	—
tag_name	path	required	string	—

Request Body

required

application/json

schema DeleteSpaceTagrequest

Property	Type	Required
tag	object	required
└ name	string	required
└ tag_bg	string	required
└ tag_fg	string	required

Responses

200 —

DELETE /space/{space_id}/tag/{tag_name}

DELETE /task/{task_id}/tag/{tag_name} Remove Tag From Task

Remove a Tag from a task. This does not delete the Tag from the Space.

operationId: Tags_removeFromTask

Parameters

Name	In	Required	Type	Description
task_id	path	required	string	—
tag_name	path	required	string	—
custom_task_ids	query	optional	boolean	If you want to reference a task by it’s custom task id, this value must be `true`.
team_id	query	optional	number	Only used when the `custom_task_ids` parameter is set to `true`.\ \ For example: `custom_task_ids=true&team_id=123`.

Responses

200 —

DELETE /task/{task_id}/tag/{tag_name}

Taskchecklists 2 endpoints

DELETE /checklist/{checklist_id} Delete Checklist

Delete a checklist from a task.

operationId: TaskChecklists_removeChecklist

Parameters

Name	In	Required	Type	Description
checklist_id	path	required	string	b8a8-48d8-a0c6-b4200788a683 (uuid)

Responses

200 —

DELETE /checklist/{checklist_id}

DELETE /checklist/{checklist_id}/checklist_item/{checklist_item_id} Delete Checklist Item

Delete a line item from a task checklist.

operationId: TaskChecklists_removeChecklistItem

Parameters

Name	In	Required	Type	Description
checklist_id	path	required	string	b8a8-48d8-a0c6-b4200788a683 (uuid)
checklist_item_id	path	required	string	e491-47f5-9fd8-d1dc4cedcc6f (uuid)

Responses

200 —

DELETE /checklist/{checklist_id}/checklist_item/{checklist_item_id}

Taskrelationships 2 endpoints

DELETE /task/{task_id}/dependency Delete Dependency

Remove the dependency relationship between two or more tasks.

operationId: TaskRelationships_removeDependency

Parameters

Name	In	Required	Type	Description
task_id	path	required	string	—
depends_on	query	required	string	—
dependency_of	query	required	string	—
custom_task_ids	query	optional	boolean	If you want to reference a task by it’s custom task id, this value must be `true`.
team_id	query	optional	number	Only used when the `custom_task_ids` parameter is set to `true`.\ \ For example: `custom_task_ids=true&team_id=123`.

Responses

200 —

DELETE /task/{task_id}/dependency

DELETE /task/{task_id}/link/{links_to} Delete Task Link

Remove the link between two tasks.

operationId: TaskRelationships_removeLinkBetweenTasks

Parameters

Name	In	Required	Type	Description
task_id	path	required	string	—
links_to	path	required	string	—
custom_task_ids	query	optional	boolean	If you want to reference a task by it’s custom task id, this value must be `true`.
team_id	query	optional	number	Only used when the `custom_task_ids` parameter is set to `true`.\ \ For example: `custom_task_ids=true&team_id=123`.

Responses

200 —

DELETE /task/{task_id}/link/{links_to}

Tasks 1 endpoints

DELETE /task/{task_id} Delete Task

Delete a task from your Workspace.

operationId: Tasks_removeTaskById

Parameters

Name	In	Required	Type	Description
task_id	path	required	string	—
custom_task_ids	query	optional	boolean	If you want to reference a task by its custom task id, this value must be `true`.
team_id	query	optional	number	Only used when the `custom_task_ids` parameter is set to `true`.\ \ For example: `custom_task_ids=true&team_id=123`.

Responses

200 —

DELETE /task/{task_id}

Teamsusergroups 1 endpoints

DELETE /group/{group_id} Delete Team

This endpoint is used to remove a Team: user group from your Workspace.\
\
In our API documentation, team_id refers to the id of a Workspace, and group_id refers to the id of a user group.

operationId: TeamsUserGroups_removeGroup

Parameters

Name	In	Required	Type	Description
group_id	path	required	string	7C73-4002-A6A9-310014852858 (string) - Team ID (user group)

Responses

200 —

DELETE /group/{group_id}

Timetracking 2 endpoints

DELETE /team/{team_id}/time_entries/tags Remove tags from time entries

Remove labels from time entries. This does not remove the label from a Workspace.

operationId: TimeTracking_removeTagsFromTimeEntries

Parameters

Name	In	Required	Type	Description
team_id	path	required	number	Team ID (Workspace)

Request Body

required

application/json

schema Removetagsfromtimeentriesrequest

Property	Type	Required
tags	array	required
└ name	string	required
time_entry_ids	array	required

Responses

200 —

DELETE /team/{team_id}/time_entries/tags

DELETE /team/{team_id}/time_entries/{timer_id} Delete a time Entry

Delete a time entry from a Workspace.

operationId: TimeTracking_removeEntry

Parameters

Name	In	Required	Type	Description
team_id	path	required	number	Team ID (Workspace)
timer_id	path	required	number	Array of timer ids to delete separated by commas

Responses

200 —

DELETE /team/{team_id}/time_entries/{timer_id}

Timetracking(legacy) 1 endpoints

DELETE /task/{task_id}/time/{interval_id} Delete time tracked

Note: This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.

operationId: TimeTrackingLegacy_removeTrackedTime

Parameters

Name	In	Required	Type	Description
task_id	path	required	string	—
interval_id	path	required	string	—
custom_task_ids	query	optional	boolean	If you want to reference a task by it’s custom task id, this value must be `true`.
team_id	query	optional	number	Only used when the `custom_task_ids` parameter is set to `true`.\ \ For example: `custom_task_ids=true&team_id=123`.

Responses

200 —

DELETE /task/{task_id}/time/{interval_id}

Users 1 endpoints

DELETE /team/{team_id}/user/{user_id} Remove User From Workspace

Deactivate a user from a Workspace. \
\
Note: This endpoint is only available to Workspaces on our Enterprise Plan.

operationId: Users_deactivateFromWorkspace

Parameters

Name	In	Required	Type	Description
team_id	path	required	number	Team ID (Workspace)
user_id	path	required	number	—

Responses

200 —

DELETE /team/{team_id}/user/{user_id}

Views 1 endpoints

DELETE /view/{view_id} Delete View

operationId: Views_deleteViewById

Parameters

Name	In	Required	Type	Description
view_id	path	required	string	105 (string)

Responses

200 —

DELETE /view/{view_id}

Webhooks 1 endpoints

DELETE /webhook/{webhook_id} Delete Webhook

Delete a webhook to stop monitoring the events and locations of the webhook.

operationId: Webhooks_removeWebhookById

Parameters

Name	In	Required	Type	Description
webhook_id	path	required	string	e506-4a29-9d42-26e504e3435e (uuid)

Responses

200 —

DELETE /webhook/{webhook_id}

Load more endpoints

Schemas

object 20bbn28

{
  "type": "object",
  "title": "20bbn28",
  "example": {
    "current_status": {
      "color": "#d3d3d3",
      "status": "open",
      "total_time": {
        "since": "1604004420925",
        "by_minute": 21830
      }
    },
    "status_history": [
      {
        "type": "open",
        "color": "#d3d3d3",
        "status": "open",
        "orderindex": 0,
        "total_time": {
          "since": "1604004420925",
          "by_minute": 22276
        }
      },
      {
        "type": "custom",
        "color": "#5CF1D4",
        "status": "active status #2",
        "orderindex": 4,
        "total_time": {
          "since": "1601597828835",
          "by_minute": 40109
        }
      }
    ]
  },
  "required": [
    "current_status",
    "status_history"
  ],
  "properties": {
    "current_status": {
      "$ref": "#/components/schemas/CurrentStatus"
    },
    "status_history": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StatusHistory"
      },
      "description": ""
    }
  },
  "x-examples": [
    {
      "current_status": {
        "color": "#d3d3d3",
        "status": "open",
        "total_time": {
          "since": "1604004420925",
          "by_minute": 21830
        }
      },
      "status_history": [
        {
          "type": "open",
          "color": "#d3d3d3",
          "status": "open",
          "orderindex": 0,
          "total_time": {
            "since": "1604004420925",
            "by_minute": 22276
          }
        },
        {
          "type": "custom",
          "color": "#5CF1D4",
          "status": "active status #2",
          "orderindex": 4,
          "total_time": {
            "since": "1601597828835",
            "by_minute": 40109
          }
        }
      ]
    }
  ]
}

object 27075wz

{
  "type": "object",
  "title": "27075wz",
  "example": {
    "current_status": {
      "color": "#d3d3d3",
      "status": "open",
      "total_time": {
        "since": "1604004423494",
        "by_minute": 21830
      }
    },
    "status_history": [
      {
        "type": "open",
        "color": "#d3d3d3",
        "status": "open",
        "orderindex": 0,
        "total_time": {
          "since": "1604004423494",
          "by_minute": 21829
        }
      },
      {
        "type": "custom",
        "color": "#5CF1D4",
        "status": "active status #2",
        "orderindex": 4,
        "total_time": {
          "since": "1602607941692",
          "by_minute": 23274
        }
      }
    ]
  },
  "required": [
    "current_status",
    "status_history"
  ],
  "properties": {
    "current_status": {
      "$ref": "#/components/schemas/CurrentStatus"
    },
    "status_history": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StatusHistory"
      },
      "description": ""
    }
  },
  "x-examples": [
    {
      "current_status": {
        "color": "#d3d3d3",
        "status": "open",
        "total_time": {
          "since": "1604004423494",
          "by_minute": 21830
        }
      },
      "status_history": [
        {
          "type": "open",
          "color": "#d3d3d3",
          "status": "open",
          "orderindex": 0,
          "total_time": {
            "since": "1604004423494",
            "by_minute": 21829
          }
        },
        {
          "type": "custom",
          "color": "#5CF1D4",
          "status": "active status #2",
          "orderindex": 4,
          "total_time": {
            "since": "1602607941692",
            "by_minute": 23274
          }
        }
      ]
    }
  ]
}

object AddDependencyrequest

{
  "type": "object",
  "title": "AddDependencyrequest",
  "example": {
    "depends_on": "9hw"
  },
  "properties": {
    "depends_on": {
      "type": "string"
    },
    "depedency_of": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "depends_on": "9hw"
    }
  ]
}

object AddGuestToFolderrequest

{
  "type": "object",
  "title": "AddGuestToFolderrequest",
  "example": {
    "permission_level": "read"
  },
  "required": [
    "permission_level"
  ],
  "properties": {
    "permission_level": {
      "type": "string",
      "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
    }
  },
  "x-examples": [
    {
      "permission_level": "read"
    }
  ]
}

object AddGuestToFolderresponse

{
  "type": "object",
  "title": "AddGuestToFolderresponse",
  "example": {
    "guest": {
      "user": {
        "id": 184,
        "role": 4,
        "color": null,
        "email": "guest@example.com",
        "initials": "G",
        "username": null,
        "date_joined": null,
        "last_active": null,
        "date_invited": "1583358383412",
        "profilePicture": null
      },
      "shared": {
        "lists": [],
        "tasks": [],
        "folders": [
          {
            "id": "1057X",
            "name": "Folder Name",
            "lists": [],
            "hidden": false,
            "archived": false,
            "statuses": [
              {
                "type": "open",
                "color": "#d3d3d3",
                "status": "Open",
                "orderindex": 0
              },
              {
                "type": "closed",
                "color": "#6bc950",
                "status": "Closed",
                "orderindex": 5
              }
            ],
            "orderindex": 5,
            "task_count": "20",
            "permission_level": "read",
            "override_statuses": true
          }
        ]
      },
      "invited_by": {
        "id": 183,
        "color": "#827718",
        "email": "jerry@example.com",
        "initials": "J",
        "username": "Jerry",
        "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
      },
      "can_edit_tags": true,
      "can_see_time_spent": true,
      "can_see_time_estimated": true
    }
  },
  "required": [
    "guest"
  ],
  "properties": {
    "guest": {
      "$ref": "#/components/schemas/Guest5"
    }
  },
  "x-examples": [
    {
      "guest": {
        "user": {
          "id": 184,
          "role": 4,
          "color": null,
          "email": "guest@example.com",
          "initials": "G",
          "username": null,
          "date_joined": null,
          "last_active": null,
          "date_invited": "1583358383412",
          "profilePicture": null
        },
        "shared": {
          "lists": [],
          "tasks": [],
          "folders": [
            {
              "id": "1057X",
              "name": "Folder Name",
              "lists": [],
              "hidden": false,
              "archived": false,
              "statuses": [
                {
                  "type": "open",
                  "color": "#d3d3d3",
                  "status": "Open",
                  "orderindex": 0
                },
                {
                  "type": "closed",
                  "color": "#6bc950",
                  "status": "Closed",
                  "orderindex": 5
                }
              ],
              "orderindex": 5,
              "task_count": "20",
              "permission_level": "read",
              "override_statuses": true
            }
          ]
        },
        "invited_by": {
          "id": 183,
          "color": "#827718",
          "email": "jerry@example.com",
          "initials": "J",
          "username": "Jerry",
          "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
        },
        "can_edit_tags": true,
        "can_see_time_spent": true,
        "can_see_time_estimated": true
      }
    }
  ]
}

object AddGuestToListrequest

{
  "type": "object",
  "title": "AddGuestToListrequest",
  "example": {
    "permission_level": "read"
  },
  "required": [
    "permission_level"
  ],
  "properties": {
    "permission_level": {
      "type": "string",
      "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
    }
  },
  "x-examples": [
    {
      "permission_level": "read"
    }
  ]
}

object AddGuestToListresponse

{
  "type": "object",
  "title": "AddGuestToListresponse",
  "example": {
    "guest": {
      "user": {
        "id": 184,
        "role": 4,
        "color": null,
        "email": "guest@example.com",
        "initials": "G",
        "username": null,
        "date_joined": null,
        "last_active": null,
        "date_invited": "1583358383412",
        "profilePicture": null
      },
      "shared": {
        "lists": [
          {
            "id": "1427X",
            "name": "List Name",
            "status": null,
            "archived": false,
            "assignee": null,
            "due_date": null,
            "priority": null,
            "statuses": [
              {
                "type": "open",
                "color": "#d3d3d3",
                "status": "Open",
                "orderindex": 0
              },
              {
                "type": "closed",
                "color": "#6bc950",
                "status": "Closed",
                "orderindex": 5
              }
            ],
            "orderindex": 1,
            "start_date": null,
            "task_count": "5",
            "permission_level": "read",
            "override_statuses": true
          }
        ],
        "tasks": [],
        "folders": []
      },
      "invited_by": {
        "id": 183,
        "color": "#827718",
        "email": "jerry@example.com",
        "initials": "J",
        "username": "Jerry",
        "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
      },
      "can_edit_tags": true,
      "can_see_time_spent": true,
      "can_see_time_estimated": true
    }
  },
  "required": [
    "guest"
  ],
  "properties": {
    "guest": {
      "$ref": "#/components/schemas/Guest3"
    }
  },
  "x-examples": [
    {
      "guest": {
        "user": {
          "id": 184,
          "role": 4,
          "color": null,
          "email": "guest@example.com",
          "initials": "G",
          "username": null,
          "date_joined": null,
          "last_active": null,
          "date_invited": "1583358383412",
          "profilePicture": null
        },
        "shared": {
          "lists": [
            {
              "id": "1427X",
              "name": "List Name",
              "status": null,
              "archived": false,
              "assignee": null,
              "due_date": null,
              "priority": null,
              "statuses": [
                {
                  "type": "open",
                  "color": "#d3d3d3",
                  "status": "Open",
                  "orderindex": 0
                },
                {
                  "type": "closed",
                  "color": "#6bc950",
                  "status": "Closed",
                  "orderindex": 5
                }
              ],
              "orderindex": 1,
              "start_date": null,
              "task_count": "5",
              "permission_level": "read",
              "override_statuses": true
            }
          ],
          "tasks": [],
          "folders": []
        },
        "invited_by": {
          "id": 183,
          "color": "#827718",
          "email": "jerry@example.com",
          "initials": "J",
          "username": "Jerry",
          "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
        },
        "can_edit_tags": true,
        "can_see_time_spent": true,
        "can_see_time_estimated": true
      }
    }
  ]
}

object AddGuestToTaskrequest

{
  "type": "object",
  "title": "AddGuestToTaskrequest",
  "example": {
    "permission_level": "read"
  },
  "required": [
    "permission_level"
  ],
  "properties": {
    "permission_level": {
      "type": "string",
      "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
    }
  },
  "x-examples": [
    {
      "permission_level": "read"
    }
  ]
}

object AddGuestToTaskresponse

{
  "type": "object",
  "title": "AddGuestToTaskresponse",
  "example": {
    "guest": {
      "user": {
        "id": 184,
        "role": 4,
        "color": null,
        "email": "guest@example.com",
        "initials": "G",
        "username": null,
        "date_joined": null,
        "last_active": null,
        "date_invited": "1583358383412",
        "profilePicture": null
      },
      "shared": {
        "lists": [],
        "tasks": [
          {
            "id": "c04X",
            "url": "https://app.clickup.com/t/c04",
            "list": {
              "id": "1752X",
              "name": "Shared with me",
              "access": false
            },
            "name": "Task Name",
            "tags": [],
            "space": {
              "id": "380X"
            },
            "folder": {
              "id": "1217X",
              "name": "Shared with me",
              "access": false,
              "hidden": false
            },
            "parent": null,
            "points": null,
            "status": {
              "type": "open",
              "color": "#d3d3d3",
              "status": "Open",
              "orderindex": 0
            },
            "creator": {
              "id": 183,
              "color": "#827718",
              "username": "Jerry",
              "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
            },
            "team_id": "108",
            "archived": false,
            "due_date": "1508369194377",
            "priority": {
              "id": "1X",
              "color": "#f50000",
              "priority": "urgent",
              "orderindex": "1"
            },
            "assignees": [],
            "checklists": [],
            "orderindex": "0",
            "start_date": null,
            "date_closed": null,
            "date_created": "1574718405408",
            "date_updated": "1574722145869",
            "dependencies": [],
            "custom_fields": [],
            "time_estimate": null,
            "permission_level": "read"
          }
        ],
        "folders": []
      },
      "invited_by": {
        "id": 183,
        "color": "#827718",
        "email": "jerry@example.com",
        "initials": "J",
        "username": "Jerry",
        "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
      },
      "can_edit_tags": true,
      "can_see_time_spent": true,
      "can_see_time_estimated": true
    }
  },
  "required": [
    "guest"
  ],
  "properties": {
    "guest": {
      "$ref": "#/components/schemas/Guest1"
    }
  },
  "x-examples": [
    {
      "guest": {
        "user": {
          "id": 184,
          "role": 4,
          "color": null,
          "email": "guest@example.com",
          "initials": "G",
          "username": null,
          "date_joined": null,
          "last_active": null,
          "date_invited": "1583358383412",
          "profilePicture": null
        },
        "shared": {
          "lists": [],
          "tasks": [
            {
              "id": "c04X",
              "url": "https://app.clickup.com/t/c04",
              "list": {
                "id": "1752X",
                "name": "Shared with me",
                "access": false
              },
              "name": "Task Name",
              "tags": [],
              "space": {
                "id": "380X"
              },
              "folder": {
                "id": "1217X",
                "name": "Shared with me",
                "access": false,
                "hidden": false
              },
              "parent": null,
              "points": null,
              "status": {
                "type": "open",
                "color": "#d3d3d3",
                "status": "Open",
                "orderindex": 0
              },
              "creator": {
                "id": 183,
                "color": "#827718",
                "username": "Jerry",
                "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
              },
              "team_id": "108",
              "archived": false,
              "due_date": "1508369194377",
              "priority": {
                "id": "1X",
                "color": "#f50000",
                "priority": "urgent",
                "orderindex": "1"
              },
              "assignees": [],
              "checklists": [],
              "orderindex": "0",
              "start_date": null,
              "date_closed": null,
              "date_created": "1574718405408",
              "date_updated": "1574722145869",
              "dependencies": [],
              "custom_fields": [],
              "time_estimate": null,
              "permission_level": "read"
            }
          ],
          "folders": []
        },
        "invited_by": {
          "id": 183,
          "color": "#827718",
          "email": "jerry@example.com",
          "initials": "J",
          "username": "Jerry",
          "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
        },
        "can_edit_tags": true,
        "can_see_time_spent": true,
        "can_see_time_estimated": true
      }
    }
  ]
}

object AddTaskLinkresponse

{
  "type": "object",
  "title": "AddTaskLinkresponse",
  "example": {
    "task": {
      "id": "9hvX",
      "url": "https://app.clickup.com/t/9hx",
      "list": {
        "id": "123X"
      },
      "name": "Task Name",
      "tags": [],
      "space": {
        "id": "789X"
      },
      "folder": {
        "id": "456X"
      },
      "parent": null,
      "status": {
        "type": "custom",
        "color": "#d3d3d3",
        "status": "in progress",
        "orderindex": 1
      },
      "creator": {
        "id": 183,
        "color": "#827718",
        "username": "John Doe",
        "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
      },
      "due_date": null,
      "priority": null,
      "assignees": [],
      "checklists": [],
      "orderindex": "1.00000000000000000000000000000000",
      "start_date": null,
      "time_spent": null,
      "date_closed": null,
      "date_created": "1567780450202",
      "date_updated": "1567780450202",
      "linked_tasks": [
        {
          "userid": "183",
          "link_id": "9hz",
          "task_id": "9hv",
          "date_created": "1587571108988"
        }
      ],
      "time_estimate": null
    }
  },
  "required": [
    "task"
  ],
  "properties": {
    "task": {
      "$ref": "#/components/schemas/Task"
    }
  },
  "x-examples": [
    {
      "task": {
        "id": "9hvX",
        "url": "https://app.clickup.com/t/9hx",
        "list": {
          "id": "123X"
        },
        "name": "Task Name",
        "tags": [],
        "space": {
          "id": "789X"
        },
        "folder": {
          "id": "456X"
        },
        "parent": null,
        "status": {
          "type": "custom",
          "color": "#d3d3d3",
          "status": "in progress",
          "orderindex": 1
        },
        "creator": {
          "id": 183,
          "color": "#827718",
          "username": "John Doe",
          "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
        },
        "due_date": null,
        "priority": null,
        "assignees": [],
        "checklists": [],
        "orderindex": "1.00000000000000000000000000000000",
        "start_date": null,
        "time_spent": null,
        "date_closed": null,
        "date_created": "1567780450202",
        "date_updated": "1567780450202",
        "linked_tasks": [
          {
            "userid": "183",
            "link_id": "9hz",
            "task_id": "9hv",
            "date_created": "1587571108988"
          }
        ],
        "time_estimate": null
      }
    }
  ]
}

object Addtagsfromtimeentriesrequest

{
  "type": "object",
  "title": "Addtagsfromtimeentriesrequest",
  "example": {
    "tags": [
      {
        "name": "name of tag",
        "tag_bg": "#BF55EC",
        "tag_fg": "#FFFFFF"
      }
    ],
    "time_entry_ids": [
      "timer_id"
    ]
  },
  "required": [
    "time_entry_ids",
    "tags"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Tags6"
      },
      "description": ""
    },
    "time_entry_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    }
  },
  "x-examples": [
    {
      "tags": [
        {
          "name": "name of tag",
          "tag_bg": "#BF55EC",
          "tag_fg": "#FFFFFF"
        }
      ],
      "time_entry_ids": [
        "timer_id"
      ]
    }
  ]
}

object AssignedBy

{
  "type": "object",
  "title": "AssignedBy",
  "example": {
    "id": 183,
    "color": "#827718",
    "email": "johndoe@gmail.com",
    "initials": "JD",
    "username": "John Doe",
    "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
  },
  "required": [
    "id",
    "username",
    "initials",
    "email",
    "color",
    "profilePicture"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "color": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "initials": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "profilePicture": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": 183,
      "color": "#827718",
      "email": "johndoe@gmail.com",
      "initials": "JD",
      "username": "John Doe",
      "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
    }
  ]
}

object Assignee

{
  "type": "object",
  "title": "Assignee",
  "example": {
    "id": 183,
    "color": "#827718",
    "email": "example@email.com",
    "initials": "JD",
    "username": "John Doe",
    "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
  },
  "required": [
    "id",
    "username",
    "email",
    "color",
    "initials",
    "profilePicture"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "color": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "initials": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "profilePicture": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": 183,
      "color": "#827718",
      "email": "example@email.com",
      "initials": "JD",
      "username": "John Doe",
      "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
    }
  ]
}

object Assignee3

{
  "type": "object",
  "title": "Assignee3",
  "example": {
    "id": 183,
    "color": "#827718",
    "initials": "J",
    "username": "Jerry",
    "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
  },
  "required": [
    "id",
    "color",
    "username",
    "initials",
    "profilePicture"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "color": {
      "type": "string"
    },
    "initials": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "profilePicture": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": 183,
      "color": "#827718",
      "initials": "J",
      "username": "Jerry",
      "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
    }
  ]
}

object Assignees

{
  "type": "object",
  "title": "Assignees",
  "example": {
    "add": [
      182
    ],
    "rem": [
      183
    ]
  },
  "required": [
    "add",
    "rem"
  ],
  "properties": {
    "add": {
      "type": "array",
      "items": {
        "type": "integer",
        "contentEncoding": "int32"
      },
      "description": ""
    },
    "rem": {
      "type": "array",
      "items": {
        "type": "integer",
        "contentEncoding": "int32"
      },
      "description": ""
    }
  },
  "x-examples": [
    {
      "add": [
        182
      ],
      "rem": [
        183
      ]
    }
  ]
}

object Assignees1

{
  "type": "object",
  "title": "Assignees1",
  "example": {
    "id": 123,
    "color": "#000000",
    "email": "johndoe@website.com",
    "username": "John Doe",
    "profilePicture": "https://clickup.com/avatar.jpg"
  },
  "required": [
    "id",
    "username",
    "color",
    "email",
    "profilePicture"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "color": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "profilePicture": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": 123,
      "color": "#000000",
      "email": "johndoe@website.com",
      "username": "John Doe",
      "profilePicture": "https://clickup.com/avatar.jpg"
    }
  ]
}

object Attachment

{
  "type": "object",
  "title": "Attachment",
  "example": {
    "id": "62447c77-2086-4cda-b274-f53eccf0547b.csv",
    "url": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
    "date": 1711570108374,
    "size": 140970,
    "type": 1,
    "user": [
      {
        "id": [
          {
            "type": "integer",
            "contentEncoding": "int32"
          }
        ],
        "color": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "initials": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "profilePicture": {
          "type": "string"
        }
      }
    ],
    "title": "Canny - Exported posts - 2024-03-09.csv",
    "hidden": false,
    "source": 1,
    "deleted": false,
    "version": 0,
    "mimetype": "text/csv",
    "extension": "csv",
    "is_folder": null,
    "parent_id": "36fjfqy",
    "email_data": null,
    "url_w_host": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
    "orientation": null,
    "url_w_query": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv?view=open",
    "total_comments": 0,
    "thumbnail_large": null,
    "thumbnail_small": null,
    "thumbnail_medium": null,
    "resolved_comments": 0
  },
  "properties": {
    "id": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "date": {
      "type": "bigint"
    },
    "size": {
      "type": "bigint"
    },
    "type": {
      "type": "int"
    },
    "user": {
      "$ref": "#/components/schemas/User2",
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "hidden": {
      "type": "boolean"
    },
    "source": {
      "type": "int"
    },
    "deleted": {
      "type": "boolean"
    },
    "version": {
      "type": "int"
    },
    "mimetype": {
      "type": "string"
    },
    "extension": {
      "type": "string"
    },
    "is_folder": {
      "type": "boolean"
    },
    "parent_id": {
      "type": "string"
    },
    "email_data": {
      "type": "object"
    },
    "url_w_host": {
      "type": "string"
    },
    "orientation": {
      "type": "string"
    },
    "url_w_query": {
      "type": "string"
    },
    "total_comments": {
      "type": "int"
    },
    "thumbnail_large": {
      "type": "string"
    },
    "thumbnail_small": {
      "type": "string"
    },
    "thumbnail_medium": {
      "type": "string"
    },
    "resolved_comments": {
      "type": "int"
    }
  },
  "x-examples": [
    {
      "id": "62447c77-2086-4cda-b274-f53eccf0547b.csv",
      "url": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
      "date": 1711570108374,
      "size": 140970,
      "type": 1,
      "user": [
        {
          "id": [
            {
              "type": "integer",
              "contentEncoding": "int32"
            }
          ],
          "color": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "initials": {
            "type": "string"
          },
          "username": {
            "type": "string"
          },
          "profilePicture": {
            "type": "string"
          }
        }
      ],
      "title": "Canny - Exported posts - 2024-03-09.csv",
      "hidden": false,
      "source": 1,
      "deleted": false,
      "version": 0,
      "mimetype": "text/csv",
      "extension": "csv",
      "is_folder": null,
      "parent_id": "36fjfqy",
      "email_data": null,
      "url_w_host": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
      "orientation": null,
      "url_w_query": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv?view=open",
      "total_comments": 0,
      "thumbnail_large": null,
      "thumbnail_small": null,
      "thumbnail_medium": null,
      "resolved_comments": 0
    }
  ]
}

object AttachmentsUploadFileToTaskAsAttachmentRequest

{
  "properties": {
    "attachment": {
      "type": "array",
      "items": {}
    }
  }
}

object Avatar

{
  "type": "object",
  "title": "Avatar",
  "example": {
    "icon": null,
    "color": null,
    "source": null,
    "attachment_id": null
  },
  "required": [
    "attachment_id",
    "color",
    "source",
    "icon"
  ],
  "properties": {
    "icon": {
      "type": [
        "string",
        "null"
      ]
    },
    "color": {
      "type": [
        "string",
        "null"
      ]
    },
    "source": {
      "type": [
        "string",
        "null"
      ]
    },
    "attachment_id": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "x-examples": [
    {
      "icon": null,
      "color": null,
      "source": null,
      "attachment_id": null
    }
  ]
}

object Changetagnamesfromtimeentriesrequest

{
  "type": "object",
  "title": "Changetagnamesfromtimeentriesrequest",
  "example": {
    "name": "old tag name",
    "tag_bg": "#000000",
    "tag_fg": "#000000",
    "new_name": "new tag name"
  },
  "required": [
    "name",
    "new_name",
    "tag_bg",
    "tag_fg"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "tag_bg": {
      "type": "string"
    },
    "tag_fg": {
      "type": "string"
    },
    "new_name": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "name": "old tag name",
      "tag_bg": "#000000",
      "tag_fg": "#000000",
      "new_name": "new tag name"
    }
  ]
}

object Checklist

{
  "type": "object",
  "title": "Checklist",
  "example": {
    "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
    "name": "Checklist",
    "items": [],
    "task_id": "9hz",
    "resolved": 0,
    "orderindex": 0,
    "unresolved": 0
  },
  "required": [
    "id",
    "task_id",
    "name",
    "orderindex",
    "resolved",
    "unresolved",
    "items"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "task_id": {
      "type": "string"
    },
    "resolved": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "orderindex": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "unresolved": {
      "type": "integer",
      "contentEncoding": "int32"
    }
  },
  "x-examples": [
    {
      "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
      "name": "Checklist",
      "items": [],
      "task_id": "9hz",
      "resolved": 0,
      "orderindex": 0,
      "unresolved": 0
    }
  ]
}

object Checklist1

{
  "type": "object",
  "title": "Checklist1",
  "example": {
    "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
    "name": "Checklist",
    "items": [
      {
        "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
        "name": "Checklist Item",
        "parent": null,
        "assignee": {
          "id": 183,
          "color": "#827718",
          "email": "example@email.com",
          "initials": "JD",
          "username": "John Doe",
          "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
        },
        "children": [],
        "resolved": false,
        "orderindex": 0,
        "date_created": "1567711566859"
      }
    ],
    "task_id": "9hv",
    "resolved": 0,
    "orderindex": 0,
    "unresolved": 1,
    "date_created": "1567711563204"
  },
  "required": [
    "id",
    "task_id",
    "name",
    "date_created",
    "orderindex",
    "resolved",
    "unresolved",
    "items"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item"
      },
      "description": ""
    },
    "task_id": {
      "type": "string"
    },
    "resolved": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "orderindex": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "unresolved": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "date_created": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
      "name": "Checklist",
      "items": [
        {
          "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
          "name": "Checklist Item",
          "parent": null,
          "assignee": {
            "id": 183,
            "color": "#827718",
            "email": "example@email.com",
            "initials": "JD",
            "username": "John Doe",
            "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
          },
          "children": [],
          "resolved": false,
          "orderindex": 0,
          "date_created": "1567711566859"
        }
      ],
      "task_id": "9hv",
      "resolved": 0,
      "orderindex": 0,
      "unresolved": 1,
      "date_created": "1567711563204"
    }
  ]
}

object Checklist2

{
  "type": "object",
  "title": "Checklist2",
  "example": {
    "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
    "name": "Checklist",
    "items": [
      {
        "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
        "name": "Updated Checklist Item",
        "parent": null,
        "assignee": null,
        "children": [],
        "resolved": true,
        "orderindex": 0,
        "date_created": "1567711566859"
      }
    ],
    "task_id": "9hv",
    "resolved": 1,
    "orderindex": 0,
    "unresolved": 0,
    "date_created": "1567711563204"
  },
  "required": [
    "id",
    "task_id",
    "name",
    "date_created",
    "orderindex",
    "resolved",
    "unresolved",
    "items"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item1"
      },
      "description": ""
    },
    "task_id": {
      "type": "string"
    },
    "resolved": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "orderindex": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "unresolved": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "date_created": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
      "name": "Checklist",
      "items": [
        {
          "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
          "name": "Updated Checklist Item",
          "parent": null,
          "assignee": null,
          "children": [],
          "resolved": true,
          "orderindex": 0,
          "date_created": "1567711566859"
        }
      ],
      "task_id": "9hv",
      "resolved": 1,
      "orderindex": 0,
      "unresolved": 0,
      "date_created": "1567711563204"
    }
  ]
}

object Checklists

{
  "type": "object",
  "title": "Checklists",
  "example": {
    "enabled": true
  },
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "x-examples": [
    {
      "enabled": true
    }
  ]
}

object Checklists6

{
  "type": "object",
  "title": "Checklists6",
  "example": {
    "id": "d41340bc-2f17-43cc-ae71-86628f45825fX",
    "name": "Checklist",
    "items": [
      {
        "id": "9398cb3d-55a4-4c45-ab46-2a47a371e375X",
        "name": "checklist item 1",
        "parent": null,
        "assignee": null,
        "children": [],
        "resolved": false,
        "orderindex": 0,
        "date_created": "1618455810454"
      }
    ],
    "creator": 2770032,
    "task_id": "3cxv9f",
    "resolved": 0,
    "orderindex": 1,
    "unresolved": 1,
    "date_created": "1618455803730"
  },
  "required": [
    "id",
    "task_id",
    "name",
    "date_created",
    "orderindex",
    "creator",
    "resolved",
    "unresolved",
    "items"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item1"
      },
      "description": ""
    },
    "creator": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "task_id": {
      "type": "string"
    },
    "resolved": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "orderindex": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "unresolved": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "date_created": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": "d41340bc-2f17-43cc-ae71-86628f45825fX",
      "name": "Checklist",
      "items": [
        {
          "id": "9398cb3d-55a4-4c45-ab46-2a47a371e375X",
          "name": "checklist item 1",
          "parent": null,
          "assignee": null,
          "children": [],
          "resolved": false,
          "orderindex": 0,
          "date_created": "1618455810454"
        }
      ],
      "creator": 2770032,
      "task_id": "3cxv9f",
      "resolved": 0,
      "orderindex": 1,
      "unresolved": 1,
      "date_created": "1618455803730"
    }
  ]
}

object Columns

{
  "type": "object",
  "title": "Columns",
  "example": {
    "fields": []
  },
  "required": [
    "fields"
  ],
  "properties": {
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Custom Fields require the `_cf` prefix and must be formatted as a JSON object."
    }
  },
  "x-examples": [
    {
      "fields": []
    }
  ],
  "description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy."
}

object Comment

{
  "type": "object",
  "title": "Comment",
  "example": {
    "id": "458X",
    "date": "1568036964079",
    "user": {
      "id": 183,
      "color": "#827718",
      "email": "johndoe@gmail.com",
      "initials": "JD",
      "username": "John Doe",
      "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
    },
    "comment": [
      {
        "text": "Task comment content"
      }
    ],
    "assignee": {
      "id": 183,
      "color": "#827718",
      "email": "johndoe@gmail.com",
      "initials": "JD",
      "username": "John Doe",
      "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
    },
    "resolved": false,
    "reactions": [],
    "assigned_by": {
      "id": 183,
      "color": "#827718",
      "email": "johndoe@gmail.com",
      "initials": "JD",
      "username": "John Doe",
      "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
    },
    "comment_text": "Task comment content"
  },
  "required": [
    "id",
    "comment",
    "comment_text",
    "user",
    "resolved",
    "assignee",
    "assigned_by",
    "reactions",
    "date"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "date": {
      "type": "string"
    },
    "user": {
      "$ref": "#/components/schemas/User2"
    },
    "comment": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Comment1"
      },
      "description": ""
    },
    "assignee": {
      "$ref": "#/components/schemas/Assignee"
    },
    "resolved": {
      "type": "boolean"
    },
    "reactions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "assigned_by": {
      "$ref": "#/components/schemas/AssignedBy"
    },
    "comment_text": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": "458X",
      "date": "1568036964079",
      "user": {
        "id": 183,
        "color": "#827718",
        "email": "johndoe@gmail.com",
        "initials": "JD",
        "username": "John Doe",
        "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
      },
      "comment": [
        {
          "text": "Task comment content"
        }
      ],
      "assignee": {
        "id": 183,
        "color": "#827718",
        "email": "johndoe@gmail.com",
        "initials": "JD",
        "username": "John Doe",
        "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
      },
      "resolved": false,
      "reactions": [],
      "assigned_by": {
        "id": 183,
        "color": "#827718",
        "email": "johndoe@gmail.com",
        "initials": "JD",
        "username": "John Doe",
        "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
      },
      "comment_text": "Task comment content"
    }
  ]
}

object Comment1

{
  "type": "object",
  "title": "Comment1",
  "example": {
    "text": "Task comment content"
  },
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "text": "Task comment content"
    }
  ]
}

object Comment2

{
  "type": "object",
  "title": "Comment2",
  "example": {
    "id": "459X",
    "date": "1568036964079",
    "user": {
      "id": 183,
      "color": "#827718",
      "email": "johndoe@gmail.com",
      "initials": "JD",
      "username": "John Doe",
      "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
    },
    "comment": [
      {
        "text": "View comment content"
      }
    ],
    "assignee": null,
    "resolved": false,
    "reactions": [],
    "assigned_by": null,
    "comment_text": "View comment content"
  },
  "required": [
    "id",
    "comment",
    "comment_text",
    "user",
    "resolved",
    "assignee",
    "assigned_by",
    "reactions",
    "date"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "date": {
      "type": "string"
    },
    "user": {
      "$ref": "#/components/schemas/User2"
    },
    "comment": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Comment1"
      },
      "description": ""
    },
    "assignee": {
      "type": [
        "string",
        "null"
      ]
    },
    "resolved": {
      "type": "boolean"
    },
    "reactions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "assigned_by": {
      "type": [
        "string",
        "null"
      ]
    },
    "comment_text": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": "459X",
      "date": "1568036964079",
      "user": {
        "id": 183,
        "color": "#827718",
        "email": "johndoe@gmail.com",
        "initials": "JD",
        "username": "John Doe",
        "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
      },
      "comment": [
        {
          "text": "View comment content"
        }
      ],
      "assignee": null,
      "resolved": false,
      "reactions": [],
      "assigned_by": null,
      "comment_text": "View comment content"
    }
  ]
}

object CommentsDeleteTaskCommentResponse

{
  "type": "object",
  "example": {},
  "x-examples": [
    {}
  ],
  "contentMediaType": "application/json"
}

object CommentsUpdateTaskCommentResponse

{
  "type": "object",
  "example": {},
  "x-examples": [
    {}
  ],
  "contentMediaType": "application/json"
}

object CreateChatViewCommentrequest

{
  "type": "object",
  "title": "CreateChatViewCommentrequest",
  "example": {
    "notify_all": true,
    "comment_text": "View comment content"
  },
  "required": [
    "comment_text",
    "notify_all"
  ],
  "properties": {
    "notify_all": {
      "type": "boolean",
      "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."
    },
    "comment_text": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "notify_all": true,
      "comment_text": "View comment content"
    }
  ]
}

object CreateChatViewCommentresponse

{
  "type": "object",
  "title": "CreateChatViewCommentresponse",
  "example": {
    "id": "459X",
    "date": 1568037065216,
    "hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae"
  },
  "required": [
    "id",
    "hist_id",
    "date"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "date": {
      "type": "integer",
      "contentEncoding": "int64"
    },
    "hist_id": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": "459X",
      "date": 1568037065216,
      "hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae"
    }
  ]
}

object CreateChecklistItemrequest

{
  "type": "object",
  "title": "CreateChecklistItemrequest",
  "example": {
    "name": "Checklist Item",
    "assignee": 183
  },
  "properties": {
    "name": {
      "type": "string"
    },
    "assignee": {
      "type": "integer",
      "contentEncoding": "int32"
    }
  },
  "x-examples": [
    {
      "name": "Checklist Item",
      "assignee": 183
    }
  ]
}

object CreateChecklistItemresponse

{
  "type": "object",
  "title": "CreateChecklistItemresponse",
  "example": {
    "checklist": {
      "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
      "name": "Checklist",
      "items": [
        {
          "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
          "name": "Checklist Item",
          "parent": null,
          "assignee": {
            "id": 183,
            "color": "#827718",
            "email": "example@email.com",
            "initials": "JD",
            "username": "John Doe",
            "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
          },
          "children": [],
          "resolved": false,
          "orderindex": 0,
          "date_created": "1567711566859"
        }
      ],
      "task_id": "9hv",
      "resolved": 0,
      "orderindex": 0,
      "unresolved": 1,
      "date_created": "1567711563204"
    }
  },
  "required": [
    "checklist"
  ],
  "properties": {
    "checklist": {
      "$ref": "#/components/schemas/Checklist1"
    }
  },
  "x-examples": [
    {
      "checklist": {
        "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
        "name": "Checklist",
        "items": [
          {
            "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
            "name": "Checklist Item",
            "parent": null,
            "assignee": {
              "id": 183,
              "color": "#827718",
              "email": "example@email.com",
              "initials": "JD",
              "username": "John Doe",
              "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
            },
            "children": [],
            "resolved": false,
            "orderindex": 0,
            "date_created": "1567711566859"
          }
        ],
        "task_id": "9hv",
        "resolved": 0,
        "orderindex": 0,
        "unresolved": 1,
        "date_created": "1567711563204"
      }
    }
  ]
}

object CreateChecklistrequest

{
  "type": "object",
  "title": "CreateChecklistrequest",
  "example": {
    "name": "Checklist"
  },
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "name": "Checklist"
    }
  ]
}

object CreateChecklistresponse

{
  "type": "object",
  "title": "CreateChecklistresponse",
  "example": {
    "checklist": {
      "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
      "name": "Checklist",
      "items": [],
      "task_id": "9hz",
      "resolved": 0,
      "orderindex": 0,
      "unresolved": 0
    }
  },
  "required": [
    "checklist"
  ],
  "properties": {
    "checklist": {
      "$ref": "#/components/schemas/Checklist"
    }
  },
  "x-examples": [
    {
      "checklist": {
        "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
        "name": "Checklist",
        "items": [],
        "task_id": "9hz",
        "resolved": 0,
        "orderindex": 0,
        "unresolved": 0
      }
    }
  ]
}

object CreateFolderViewrequest

{
  "type": "object",
  "title": "CreateFolderViewrequest",
  "example": {
    "name": "New Folder View Name",
    "type": "list",
    "divide": {
      "dir": null,
      "field": null,
      "collapsed": []
    },
    "columns": {
      "fields": []
    },
    "filters": {
      "op": "AND",
      "fields": [],
      "search": "",
      "show_closed": false
    },
    "sorting": {
      "fields": []
    },
    "grouping": {
      "dir": 1,
      "field": "status",
      "ignore": false,
      "collapsed": []
    },
    "settings": {
      "me_comments": true,
      "me_subtasks": true,
      "show_images": true,
      "me_checklists": true,
      "show_subtasks": 3,
      "show_assignees": true,
      "show_task_locations": false,
      "show_closed_subtasks": false,
      "collapse_empty_columns": null,
      "show_subtask_parent_names": false
    },
    "team_sidebar": {
      "assignees": [],
      "unassigned_tasks": false,
      "assigned_comments": false
    }
  },
  "required": [
    "name",
    "type",
    "grouping",
    "divide",
    "sorting",
    "filters",
    "columns",
    "team_sidebar",
    "settings"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
    },
    "divide": {
      "$ref": "#/components/schemas/Divide"
    },
    "columns": {
      "$ref": "#/components/schemas/Columns"
    },
    "filters": {
      "$ref": "#/components/schemas/Filters"
    },
    "sorting": {
      "$ref": "#/components/schemas/Sorting"
    },
    "grouping": {
      "$ref": "#/components/schemas/Grouping"
    },
    "settings": {
      "$ref": "#/components/schemas/Settings"
    },
    "team_sidebar": {
      "$ref": "#/components/schemas/TeamSidebar"
    }
  },
  "x-examples": [
    {
      "name": "New Folder View Name",
      "type": "list",
      "divide": {
        "dir": null,
        "field": null,
        "collapsed": []
      },
      "columns": {
        "fields": []
      },
      "filters": {
        "op": "AND",
        "fields": [],
        "search": "",
        "show_closed": false
      },
      "sorting": {
        "fields": []
      },
      "grouping": {
        "dir": 1,
        "field": "status",
        "ignore": false,
        "collapsed": []
      },
      "settings": {
        "me_comments": true,
        "me_subtasks": true,
        "show_images": true,
        "me_checklists": true,
        "show_subtasks": 3,
        "show_assignees": true,
        "show_task_locations": false,
        "show_closed_subtasks": false,
        "collapse_empty_columns": null,
        "show_subtask_parent_names": false
      },
      "team_sidebar": {
        "assignees": [],
        "unassigned_tasks": false,
        "assigned_comments": false
      }
    }
  ]
}

object CreateFolderViewresponse

{
  "type": "object",
  "title": "CreateFolderViewresponse",
  "example": {
    "view": {
      "id": "3c-107X",
      "name": "New Folder View Name",
      "type": "list",
      "divide": {
        "dir": null,
        "field": null,
        "collapsed": []
      },
      "parent": {
        "id": "457X",
        "type": 5
      },
      "columns": {
        "fields": []
      },
      "filters": {
        "op": "AND",
        "fields": [],
        "search": "",
        "show_closed": false
      },
      "sorting": {
        "fields": []
      },
      "grouping": {
        "dir": 1,
        "field": "status",
        "ignore": false,
        "collapsed": []
      },
      "settings": {
        "me_comments": true,
        "me_subtasks": true,
        "show_images": true,
        "me_checklists": true,
        "show_subtasks": 3,
        "show_assignees": true,
        "show_task_locations": false,
        "show_closed_subtasks": false,
        "collapse_empty_columns": null,
        "show_subtask_parent_names": false
      },
      "team_sidebar": {
        "assignees": [],
        "unassigned_tasks": false,
        "assigned_comments": false
      }
    }
  },
  "required": [
    "view"
  ],
  "properties": {
    "view": {
      "$ref": "#/components/schemas/View"
    }
  },
  "x-examples": [
    {
      "view": {
        "id": "3c-107X",
        "name": "New Folder View Name",
        "type": "list",
        "divide": {
          "dir": null,
          "field": null,
          "collapsed": []
        },
        "parent": {
          "id": "457X",
          "type": 5
        },
        "columns": {
          "fields": []
        },
        "filters": {
          "op": "AND",
          "fields": [],
          "search": "",
          "show_closed": false
        },
        "sorting": {
          "fields": []
        },
        "grouping": {
          "dir": 1,
          "field": "status",
          "ignore": false,
          "collapsed": []
        },
        "settings": {
          "me_comments": true,
          "me_subtasks": true,
          "show_images": true,
          "me_checklists": true,
          "show_subtasks": 3,
          "show_assignees": true,
          "show_task_locations": false,
          "show_closed_subtasks": false,
          "collapse_empty_columns": null,
          "show_subtask_parent_names": false
        },
        "team_sidebar": {
          "assignees": [],
          "unassigned_tasks": false,
          "assigned_comments": false
        }
      }
    }
  ]
}

object CreateFolderlessListrequest

{
  "type": "object",
  "title": "CreateFolderlessListrequest",
  "example": {
    "name": "New List Name",
    "status": "red",
    "content": "New List Content",
    "assignee": 183,
    "due_date": 1567780450202,
    "priority": 1,
    "due_date_time": false
  },
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "**Status** refers to the List color rather than the task Statuses available in the List."
    },
    "content": {
      "type": "string"
    },
    "assignee": {
      "type": "integer",
      "description": "Include a `user_id` to add a List owner.",
      "contentEncoding": "int32"
    },
    "due_date": {
      "type": "integer",
      "contentEncoding": "int64"
    },
    "priority": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "due_date_time": {
      "type": "boolean"
    }
  },
  "x-examples": [
    {
      "name": "New List Name",
      "status": "red",
      "content": "New List Content",
      "assignee": 183,
      "due_date": 1567780450202,
      "priority": 1,
      "due_date_time": false
    }
  ]
}

object CreateFolderlessListresponse

{
  "type": "object",
  "title": "CreateFolderlessListresponse",
  "example": {
    "id": "124X",
    "name": "New List Name",
    "space": {
      "id": "789X",
      "name": "Space Name",
      "access": true
    },
    "folder": {
      "id": "457X",
      "name": "hidden",
      "access": true,
      "hidden": true
    },
    "status": {
      "color": "#e50000",
      "status": "red",
      "hide_label": true
    },
    "content": "New List Content",
    "assignee": {
      "id": 183,
      "color": "#827718",
      "initials": "J",
      "username": "Jerry",
      "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
    },
    "due_date": "1567780450202",
    "priority": {
      "color": "#f50000",
      "priority": "urgent"
    },
    "statuses": [
      {
        "type": "open",
        "color": "#d3d3d3",
        "status": "to do",
        "orderindex": 0
      },
      {
        "type": "closed",
        "color": "#6bc950",
        "status": "complete",
        "orderindex": 1
      }
    ],
    "orderindex": 1,
    "start_date": null,
    "task_count": null,
    "due_date_time": false,
    "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
    "start_date_time": null
  },
  "required": [
    "id",
    "name",
    "orderindex",
    "content",
    "status",
    "priority",
    "assignee",
    "task_count",
    "due_date",
    "due_date_time",
    "start_date",
    "start_date_time",
    "folder",
    "space",
    "statuses",
    "inbound_address"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "space": {
      "$ref": "#/components/schemas/Space2"
    },
    "folder": {
      "$ref": "#/components/schemas/Folder3"
    },
    "status": {
      "$ref": "#/components/schemas/Status5"
    },
    "content": {
      "type": "string"
    },
    "assignee": {
      "$ref": "#/components/schemas/Assignee3"
    },
    "due_date": {
      "type": "string"
    },
    "priority": {
      "$ref": "#/components/schemas/Priority1"
    },
    "statuses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Status"
      },
      "description": ""
    },
    "orderindex": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "start_date": {
      "type": [
        "string",
        "null"
      ]
    },
    "task_count": {
      "type": [
        "string",
        "null"
      ]
    },
    "due_date_time": {
      "type": "boolean"
    },
    "inbound_address": {
      "type": "string"
    },
    "start_date_time": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "x-examples": [
    {
      "id": "124X",
      "name": "New List Name",
      "space": {
        "id": "789X",
        "name": "Space Name",
        "access": true
      },
      "folder": {
        "id": "457X",
        "name": "hidden",
        "access": true,
        "hidden": true
      },
      "status": {
        "color": "#e50000",
        "status": "red",
        "hide_label": true
      },
      "content": "New List Content",
      "assignee": {
        "id": 183,
        "color": "#827718",
        "initials": "J",
        "username": "Jerry",
        "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
      },
      "due_date": "1567780450202",
      "priority": {
        "color": "#f50000",
        "priority": "urgent"
      },
      "statuses": [
        {
          "type": "open",
          "color": "#d3d3d3",
          "status": "to do",
          "orderindex": 0
        },
        {
          "type": "closed",
          "color": "#6bc950",
          "status": "complete",
          "orderindex": 1
        }
      ],
      "orderindex": 1,
      "start_date": null,
      "task_count": null,
      "due_date_time": false,
      "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
      "start_date_time": null
    }
  ]
}

object CreateFolderrequest

{
  "type": "object",
  "title": "CreateFolderrequest",
  "example": {
    "name": "New Folder Name"
  },
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "name": "New Folder Name"
    }
  ]
}

object CreateFolderresponse

{
  "type": "object",
  "title": "CreateFolderresponse",
  "example": {
    "id": "457X",
    "name": "New Folder Name",
    "space": {
      "id": "789X",
      "name": "Space Name",
      "access": true
    },
    "hidden": false,
    "orderindex": 0,
    "task_count": "0",
    "override_statuses": false
  },
  "required": [
    "id",
    "name",
    "orderindex",
    "override_statuses",
    "hidden",
    "space",
    "task_count"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "space": {
      "$ref": "#/components/schemas/Space2"
    },
    "hidden": {
      "type": "boolean"
    },
    "orderindex": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "task_count": {
      "type": "string"
    },
    "override_statuses": {
      "type": "boolean"
    }
  },
  "x-examples": [
    {
      "id": "457X",
      "name": "New Folder Name",
      "space": {
        "id": "789X",
        "name": "Space Name",
        "access": true
      },
      "hidden": false,
      "orderindex": 0,
      "task_count": "0",
      "override_statuses": false
    }
  ]
}

object CreateGoalrequest

{
  "type": "object",
  "title": "CreateGoalrequest",
  "example": {
    "name": "Goal Name",
    "color": "#32a852",
    "owners": [
      183
    ],
    "due_date": 1568036964079,
    "description": "Goal Description",
    "multiple_owners": true
  },
  "required": [
    "name",
    "due_date",
    "description",
    "multiple_owners",
    "owners",
    "color"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "color": {
      "type": "string"
    },
    "owners": {
      "type": "array",
      "items": {
        "type": "integer",
        "contentEncoding": "int32"
      },
      "description": "Array of user IDs."
    },
    "due_date": {
      "type": "integer",
      "contentEncoding": "int64"
    },
    "description": {
      "type": "string"
    },
    "multiple_owners": {
      "type": "boolean"
    }
  },
  "x-examples": [
    {
      "name": "Goal Name",
      "color": "#32a852",
      "owners": [
        183
      ],
      "due_date": 1568036964079,
      "description": "Goal Description",
      "multiple_owners": true
    }
  ]
}

object CreateGoalresponse

{
  "type": "object",
  "title": "CreateGoalresponse",
  "example": {
    "goal": {
      "id": "e53a033c-900e-462d-a849-4a216b06d930X",
      "name": "Goal Name",
      "color": "#32a852",
      "owners": [
        {
          "id": 183,
          "color": "#827718",
          "email": "johndoe@gmail.com",
          "initials": "JD",
          "username": "John Doe",
          "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
        }
      ],
      "creator": 183,
      "history": [],
      "members": [],
      "private": false,
      "team_id": "512",
      "archived": false,
      "due_date": "1568036964079",
      "folder_id": null,
      "pretty_id": "6",
      "pretty_url": "https://app.clickup.com/512/goals/6",
      "start_date": null,
      "description": "Goal Description",
      "key_results": [],
      "date_created": "1568044355026",
      "multiple_owners": true,
      "percent_completed": 0
    }
  },
  "required": [
    "goal"
  ],
  "properties": {
    "goal": {
      "$ref": "#/components/schemas/Goal"
    }
  },
  "x-examples": [
    {
      "goal": {
        "id": "e53a033c-900e-462d-a849-4a216b06d930X",
        "name": "Goal Name",
        "color": "#32a852",
        "owners": [
          {
            "id": 183,
            "color": "#827718",
            "email": "johndoe@gmail.com",
            "initials": "JD",
            "username": "John Doe",
            "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
          }
        ],
        "creator": 183,
        "history": [],
        "members": [],
        "private": false,
        "team_id": "512",
        "archived": false,
        "due_date": "1568036964079",
        "folder_id": null,
        "pretty_id": "6",
        "pretty_url": "https://app.clickup.com/512/goals/6",
        "start_date": null,
        "description": "Goal Description",
        "key_results": [],
        "date_created": "1568044355026",
        "multiple_owners": true,
        "percent_completed": 0
      }
    }
  ]
}

object CreateKeyResultrequest

{
  "type": "object",
  "title": "CreateKeyResultrequest",
  "example": {
    "name": "New Target Name",
    "type": "number",
    "unit": "km",
    "owners": [
      183
    ],
    "list_ids": [],
    "task_ids": [],
    "steps_end": 10,
    "steps_start": 0
  },
  "required": [
    "name",
    "owners",
    "type",
    "steps_start",
    "steps_end",
    "unit",
    "task_ids",
    "list_ids"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`."
    },
    "unit": {
      "type": "string"
    },
    "owners": {
      "type": "array",
      "items": {
        "type": "integer",
        "contentEncoding": "int32"
      },
      "description": ""
    },
    "list_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Enter an array of List IDs to link this target with one or more Lists."
    },
    "task_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Enter an array of task IDs to link this target with one or more tasks."
    },
    "steps_end": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "steps_start": {
      "type": "integer",
      "contentEncoding": "int32"
    }
  },
  "x-examples": [
    {
      "name": "New Target Name",
      "type": "number",
      "unit": "km",
      "owners": [
        183
      ],
      "list_ids": [],
      "task_ids": [],
      "steps_end": 10,
      "steps_start": 0
    }
  ]
}

object CreateKeyResultresponse

{
  "type": "object",
  "title": "CreateKeyResultresponse",
  "example": {
    "key_result": {
      "id": "947d46ed-8480-49bc-8c57-e569747efe93X",
      "name": "New Key Result Name",
      "type": "number",
      "unit": "km",
      "owners": [
        {
          "id": 183,
          "color": "#827718",
          "email": "example@email.com",
          "initials": "JK",
          "username": "John Doe",
          "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
        }
      ],
      "creator": 183,
      "goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
      "task_ids": [],
      "completed": false,
      "last_action": {
        "id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
        "note": "Created Key Result",
        "userid": 183,
        "steps_taken": null,
        "steps_before": null,
        "date_modified": "1568062902048",
        "key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
        "steps_current": null
      },
      "date_created": "1568062902048",
      "goal_pretty_id": "6",
      "subcategory_ids": [],
      "percent_completed": null
    }
  },
  "required": [
    "key_result"
  ],
  "properties": {
    "key_result": {
      "$ref": "#/components/schemas/KeyResult"
    }
  },
  "x-examples": [
    {
      "key_result": {
        "id": "947d46ed-8480-49bc-8c57-e569747efe93X",
        "name": "New Key Result Name",
        "type": "number",
        "unit": "km",
        "owners": [
          {
            "id": 183,
            "color": "#827718",
            "email": "example@email.com",
            "initials": "JK",
            "username": "John Doe",
            "profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
          }
        ],
        "creator": 183,
        "goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
        "task_ids": [],
        "completed": false,
        "last_action": {
          "id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
          "note": "Created Key Result",
          "userid": 183,
          "steps_taken": null,
          "steps_before": null,
          "date_modified": "1568062902048",
          "key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
          "steps_current": null
        },
        "date_created": "1568062902048",
        "goal_pretty_id": "6",
        "subcategory_ids": [],
        "percent_completed": null
      }
    }
  ]
}

object CreateListCommentrequest

{
  "type": "object",
  "title": "CreateListCommentrequest",
  "example": {
    "assignee": 183,
    "notify_all": true,
    "comment_text": "List comment content"
  },
  "required": [
    "comment_text",
    "assignee",
    "notify_all"
  ],
  "properties": {
    "assignee": {
      "type": "integer",
      "contentEncoding": "int32"
    },
    "notify_all": {
      "type": "boolean",
      "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."
    },
    "comment_text": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "assignee": 183,
      "notify_all": true,
      "comment_text": "List comment content"
    }
  ]
}

object CreateListCommentresponse

{
  "type": "object",
  "title": "CreateListCommentresponse",
  "example": {
    "id": "462X",
    "date": 1568037341249,
    "hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08"
  },
  "required": [
    "id",
    "hist_id",
    "date"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "date": {
      "type": "integer",
      "contentEncoding": "int64"
    },
    "hist_id": {
      "type": "string"
    }
  },
  "x-examples": [
    {
      "id": "462X",
      "date": 1568037341249,
      "hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08"
    }
  ]
}

object CreateListViewrequest

{
  "type": "object",
  "title": "CreateListViewrequest",
  "example": {
    "name": "New List View Name",
    "type": "list",
    "divide": {
      "dir": null,
      "field": null,
      "collapsed": []
    },
    "columns": {
      "fields": []
    },
    "filters": {
      "op": "AND",
      "fields": [],
      "search": "",
      "show_closed": false
    },
    "sorting": {
      "fields": []
    },
    "grouping": {
      "dir": 1,
      "field": "status",
      "ignore": false,
      "collapsed": []
    },
    "settings": {
      "me_comments": true,
      "me_subtasks": true,
      "show_images": true,
      "me_checklists": true,
      "show_subtasks": 3,
      "show_assignees": true,
      "show_task_locations": false,
      "show_closed_subtasks": false,
      "collapse_empty_columns": null,
      "show_subtask_parent_names": false
    },
    "team_sidebar": {
      "assignees": [],
      "unassigned_tasks": false,
      "assigned_comments": false
    }
  },
  "required": [
    "name",
    "type",
    "grouping",
    "divide",
    "sorting",
    "filters",
    "columns",
    "team_sidebar",
    "settings"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
    },
    "divide": {
      "$ref": "#/components/schemas/Divide"
    },
    "columns": {
      "$ref": "#/components/schemas/Columns"
    },
    "filters": {
      "$ref": "#/components/schemas/Filters"
    },
    "sorting": {
      "$ref": "#/components/schemas/Sorting"
    },
    "grouping": {
      "$ref": "#/components/schemas/Grouping"
    },
    "settings": {
      "$ref": "#/components/schemas/Settings"
    },
    "team_sidebar": {
      "$ref": "#/components/schemas/TeamSidebar"
    }
  },
  "x-examples": [
    {
      "name": "New List View Name",
      "type": "list",
      "divide": {
        "dir": null,
        "field": null,
        "collapsed": []
      },
      "columns": {
        "fields": []
      },
      "filters": {
        "op": "AND",
        "fields": [],
        "search": "",
        "show_closed": false
      },
      "sorting": {
        "fields": []
      },
      "grouping": {
        "dir": 1,
        "field": "status",
        "ignore": false,
        "collapsed": []
      },
      "settings": {
        "me_comments": true,
        "me_subtasks": true,
        "show_images": true,
        "me_checklists": true,
        "show_subtasks": 3,
        "show_assignees": true,
        "show_task_locations": false,
        "show_closed_subtasks": false,
        "collapse_empty_columns": null,
        "show_subtask_parent_names": false
      },
      "team_sidebar": {
        "assignees": [],
        "unassigned_tasks": false,
        "assigned_comments": false
      }
    }
  ]
}

Load more schemas