Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.clickup.com/api/v2
https://a00fb6e0-339c-4201-972f-503b9932d17a.remockly.com
/team
View the Workspaces available to the authenticated user.
GET /team
/user
View the details of the authenticated user’s ClickUp account.
GET /user
/list/{list_id}/comment
View the comments added to a List. \
\
If you do not include the start and start_id parameters, this endpoint will return the most recent 25 comments.\
\
Use the start and start id parameters of the oldest comment to retrieve the next 25 comments.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | number | — |
| start | query | optional | integer | Enter the |
| start_id | query | optional | string | Enter the Comment |
GET /list/{list_id}/comment
/task/{task_id}/comment
View task comments. \
\
If you do not include the start and start_id parameters, this endpoint will return the most recent 25 comments.\
\
Use the start and start id parameters of the oldest comment to retrieve the next 25 comments.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| task_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 |
| team_id | query | optional | number | Only used when the |
| start | query | optional | integer | Enter the |
| start_id | query | optional | string | Enter the Comment |
GET /task/{task_id}/comment
/view/{view_id}/comment
View comments from a Chat view. \
\
If you do not include the start and start_id parameters, this endpoint will return the most recent 25 comments.\
\
Use the start and start id parameters of the oldest comment to retrieve the next 25 comments.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| view_id | path | required | string | 105 (string) |
| start | query | optional | integer | Enter the |
| start_id | query | optional | string | Enter the Comment |
GET /view/{view_id}/comment
/list/{list_id}/field
View the Custom Fields available on tasks in a specific List.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | number | — |
GET /list/{list_id}/field
/team/{team_id}/custom_item
View the custom task types available in a Workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
GET /team/{team_id}/custom_item
/folder/{folder_id}
View the Lists within a Folder.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| folder_id | path | required | number | — |
GET /folder/{folder_id}
/space/{space_id}/folder
View the Folders in a Space.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| space_id | path | required | number | — |
| archived | query | optional | boolean | — |
GET /space/{space_id}/folder
/goal/{goal_id}
View the details of a Goal including its Targets.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| goal_id | path | required | string | 900e-462d-a849-4a216b06d930 (uuid) |
GET /goal/{goal_id}
/team/{team_id}/goal
View the Goals available in a Workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
| include_completed | query | optional | boolean | — |
GET /team/{team_id}/goal
/team/{team_id}/guest/{guest_id}
View information about a guest. \
\
Note: This endpoint is only available to Workspaces on our Enterprise Plan.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
| guest_id | path | required | number | — |
GET /team/{team_id}/guest/{guest_id}
/folder/{folder_id}/list
View the Lists within a Folder.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| folder_id | path | required | number | — |
| archived | query | optional | boolean | — |
GET /folder/{folder_id}/list
/list/{list_id}
View information about a List.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | number | — |
GET /list/{list_id}
/space/{space_id}/list
View the Lists in a Space that aren’t located in a Folder.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| space_id | path | required | number | — |
| archived | query | optional | boolean | — |
GET /space/{space_id}/list
/list/{list_id}/member
View the people who have access to a List.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | number | — |
GET /list/{list_id}/member
/task/{task_id}/member
View the people who have access to a task.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| task_id | path | required | string | — |
GET /task/{task_id}/member
/team/{team_id}/customroles
View the Custom Roles available in a Workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | — |
| include_members | query | optional | boolean | — |
GET /team/{team_id}/customroles
/space/{space_id}
View the Spaces available in a Workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| space_id | path | required | number | — |
GET /space/{space_id}
/team/{team_id}/space
View the Spaces avialable in a Workspace. You can only get member info in private Spaces.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
| archived | query | optional | boolean | — |
GET /team/{team_id}/space
/space/{space_id}/tag
View the task Tags available in a Space.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| space_id | path | required | number | — |
GET /space/{space_id}/tag
/team/{team_id}/taskTemplate
View the task templates available in a Workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
| page | query | required | integer | — |
GET /team/{team_id}/taskTemplate
/list/{list_id}/task
View the tasks in a List. Responses are limited to 100 tasks per page. You can only view task information of tasks you can access. \
\
This endpoint only includes tasks where the specified list_id is their home List. Tasks added to the list_id with a different home List are not included in the response.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | number | To find the list_id: |
| archived | query | optional | boolean | — |
| include_markdown_description | query | optional | boolean | To return task descriptions in Markdown format, use |
| page | query | optional | integer | Page to fetch (starts at 0). |
| order_by | query | optional | string | Order by a particular field. By default, tasks are ordered by |
| reverse | query | optional | boolean | Tasks are displayed in reverse order. |
| subtasks | query | optional | boolean | Include or exclude subtasks. By default, subtasks are excluded. |
| statuses | query | optional | array | Filter by statuses. To include closed tasks, use the |
| include_closed | query | optional | boolean | Include or excluse closed tasks. By default, they are excluded.\ |
| assignees | query | optional | array | Filter by Assignees. For example: \ |
| watchers | query | optional | array | Filter by watchers. |
| tags | query | optional | array | Filter by tags. For example: \ |
| due_date_gt | query | optional | integer | Filter by due date greater than Unix time in milliseconds. |
| due_date_lt | query | optional | integer | Filter by due date less than Unix time in milliseconds. |
| date_created_gt | query | optional | integer | Filter by date created greater than Unix time in milliseconds. |
| date_created_lt | query | optional | integer | Filter by date created less than Unix time in milliseconds. |
| date_updated_gt | query | optional | integer | Filter by date updated greater than Unix time in milliseconds. |
| date_updated_lt | query | optional | integer | Filter by date updated less than Unix time in milliseconds. |
| date_done_gt | query | optional | integer | Filter by date done greater than Unix time in milliseconds. |
| date_done_lt | query | optional | integer | Filter by date done less than Unix time in milliseconds. |
| custom_fields | query | optional | array | Include tasks with specific values in multiple Custom Fields.\ |
| custom_items | query | optional | array | Filter by custom task types. For example: \ |
GET /list/{list_id}/task
/task/bulk_time_in_status/task_ids
View how long two or more tasks have been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| task_ids | query | required | string | Include this paramater once per |
| custom_task_ids | query | optional | boolean | If you want to reference a task by it’s custom task id, this value must be |
| team_id | query | optional | number | Only used when the |
GET /task/bulk_time_in_status/task_ids
/task/{task_id}
View information about a task. You can only view task information of tasks you can access. \
\
Tasks with attachments will return an “attachments” response.
| 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 |
| team_id | query | optional | number | Only used when the |
| include_subtasks | query | optional | boolean | Include subtasks, default false |
| include_markdown_description | query | optional | boolean | To return task descriptions in Markdown format, use |
GET /task/{task_id}
/task/{task_id}/time_in_status
View how long a task has been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| task_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 |
| team_id | query | optional | number | Only used when the |
GET /task/{task_id}/time_in_status
/team/{team_Id}/task
View the tasks that meet specific criteria from a Workspace. Responses are limited to 100 tasks per page. \
\
You can only view task information of tasks you can access.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_Id | path | required | number | Team ID (Workspace) |
| page | query | optional | integer | Page to fetch (starts at 0). |
| order_by | query | optional | string | Order by a particular field. By default, tasks are ordered by |
| reverse | query | optional | boolean | Tasks are displayed in reverse order. |
| subtasks | query | optional | boolean | Include or exclude subtasks. By default, subtasks are excluded. |
| space_ids | query | optional | array | Filter by Spaces. For example: \ |
| project_ids | query | optional | array | Filter by Folders. For example: \ |
| list_ids | query | optional | array | Filter by Lists. For example: \ |
| statuses | query | optional | array | Filter by statuses. Use |
| include_closed | query | optional | boolean | Include or excluse closed tasks. By default, they are excluded.\ |
| assignees | query | optional | array | Filter by Assignees using people’s ClickUp user id. For example: \ |
| tags | query | optional | array | Filter by tags. User |
| due_date_gt | query | optional | integer | Filter by due date greater than Unix time in milliseconds. |
| due_date_lt | query | optional | integer | Filter by due date less than Unix time in milliseconds. |
| date_created_gt | query | optional | integer | Filter by date created greater than Unix time in milliseconds. |
| date_created_lt | query | optional | integer | Filter by date created less than Unix time in milliseconds. |
| date_updated_gt | query | optional | integer | Filter by date updated greater than Unix time in milliseconds. |
| date_updated_lt | query | optional | integer | Filter by date updated less than Unix time in milliseconds. |
| date_done_gt | query | optional | integer | Filter by date done greater than Unix time in milliseconds. |
| date_done_lt | query | optional | integer | Filter by date done less than Unix time in milliseconds. |
| custom_fields | query | optional | array | Include tasks with specific values in one or more Custom Fields.\ |
| custom_task_ids | query | optional | boolean | If you want to reference a task by its custom task id, this value must be |
| team_id | query | optional | number | Only used when the |
| parent | query | optional | string | Include the parent task ID to return subtasks. |
| include_markdown_description | query | optional | boolean | To return task descriptions in Markdown format, use |
| custom_items | query | optional | array | Filter by custom task types. For example: \ |
GET /team/{team_Id}/task
/group
This endpoint is used to view Teams: user groups in 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.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | query | optional | number | Team ID (Workspace) |
| group_ids | query | optional | string | Enter one or more Team ids (user groups) to retrieve information about specific Teams. |
GET /group
/team/{team_id}/plan
View the current Plan for the specified Workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | string | Team ID (Workspace) |
GET /team/{team_id}/plan
/team/{team_id}/seats
View the used, total, and available member and guest seats for a Workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | string | Team ID (Workspace) |
GET /team/{team_id}/seats
/team/{team_Id}/time_entries
View time entries filtered by start and end date. \
\
By default, this endpoint returns time entries from the last 30 days created by the authenticated user. \
\
To retrieve time entries for other users, you must include the assignee query parameter. \
\
Only one of the following location filters can be included at a time: space_id, folder_id, list_id, or task_id. \
\
Note: A time entry that has a negative duration means that timer is currently running for that user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_Id | path | required | number | Team ID (Workspace) |
| start_date | query | optional | number | Unix time in milliseconds |
| end_date | query | optional | number | Unix time in milliseconds |
| assignee | query | optional | number | Filter by |
| include_task_tags | query | optional | boolean | Include task tags in the response for time entries associated with tasks. |
| include_location_names | query | optional | boolean | Include the names of the List, Folder, and Space along with the |
| space_id | query | optional | number | Only include time entries associated with tasks in a specific Space. |
| folder_id | query | optional | number | Only include time entries associated with tasks in a specific Folder. |
| list_id | query | optional | number | Only include time entries associated with tasks in a specific List. |
| task_id | query | optional | string | Only include time entries associated with a specific task. |
| custom_task_ids | query | optional | boolean | If you want to reference a task by it’s custom task id, this value must be |
| team_id | query | optional | number | Only used when the |
| is_billable | query | optional | boolean | Include only billable time entries by using a value of |
If your time entry is associated with a task that uses custom task ids you can expect a custom_id` field in the body of the response. The task field will only be included if there is a task associated with a time entry.
GET /team/{team_Id}/time_entries
/team/{team_id}/time_entries/current
View a time entry that’s currently tracking time for the authenticated user. \
\
Note: A time entry that has a negative duration means that timer is currently running for that user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
| assignee | query | optional | number | user id |
GET /team/{team_id}/time_entries/current
/team/{team_id}/time_entries/tags
View all the labels that have been applied to time entries in a Workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
GET /team/{team_id}/time_entries/tags
/team/{team_id}/time_entries/{timer_id}
View a single time entry. \
\
Note: A time entry that has a negative duration means that timer is currently running for that user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
| timer_id | path | required | string | The ID of a time entry. \ |
| include_task_ | query | optional | boolean | Include task in the response for time entries associated with tasks. |
| include_location_names | query | optional | boolean | Include the names of the List, Folder, and Space along with |
GET /team/{team_id}/time_entries/{timer_id}
/team/{team_id}/time_entries/{timer_id}/history
View a list of changes made to a time entry.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
| timer_id | path | required | string | The ID of a time entry. \ |
GET /team/{team_id}/time_entries/{timer_id}/history
/task/{task_id}/time
Note: This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| task_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 |
| team_id | query | optional | number | Only used when the |
GET /task/{task_id}/time
/team/{team_id}/user/{user_id}
View information about a user in a Workspace. \
\
Note: This endpoint is only available to Workspaces on our Enterprise Plan.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
| user_id | path | required | number | — |
GET /team/{team_id}/user/{user_id}
/folder/{folder_id}/view
View the task and page views available for a Folder.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| folder_id | path | required | number | — |
GET /folder/{folder_id}/view
/list/{list_id}/view
View the task and page views available for a List.
Views and required views are separate responses.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | number | — |
GET /list/{list_id}/view
/space/{space_id}/view
View the task and page views available for a Space.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| space_id | path | required | number | — |
GET /space/{space_id}/view
/team/{team_id}/view
View the task and page views available at the Everything Level of a Workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
GET /team/{team_id}/view
/view/{view_id}
View information about a specific task or page view.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| view_id | path | required | string | — |
GET /view/{view_id}
/view/{view_id}/task
See all visible tasks in a view in ClickUp.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| view_id | path | required | string | 105 (string) |
| page | query | required | integer | — |
GET /view/{view_id}/task
/team/{team_id}/webhook
View the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| team_id | path | required | number | Team ID (Workspace) |
GET /team/{team_id}/webhook
20bbn28
{
"type": "object",
"title": "20bbn28",
"example": {
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004420925",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004420925",
"by_minute": 22276
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1601597828835",
"by_minute": 40109
}
}
]
},
"required": [
"current_status",
"status_history"
],
"properties": {
"current_status": {
"$ref": "#/components/schemas/CurrentStatus"
},
"status_history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusHistory"
},
"description": ""
}
},
"x-examples": [
{
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004420925",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004420925",
"by_minute": 22276
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1601597828835",
"by_minute": 40109
}
}
]
}
]
}
27075wz
{
"type": "object",
"title": "27075wz",
"example": {
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21829
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1602607941692",
"by_minute": 23274
}
}
]
},
"required": [
"current_status",
"status_history"
],
"properties": {
"current_status": {
"$ref": "#/components/schemas/CurrentStatus"
},
"status_history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusHistory"
},
"description": ""
}
},
"x-examples": [
{
"current_status": {
"color": "#d3d3d3",
"status": "open",
"total_time": {
"since": "1604004423494",
"by_minute": 21830
}
},
"status_history": [
{
"type": "open",
"color": "#d3d3d3",
"status": "open",
"orderindex": 0,
"total_time": {
"since": "1604004423494",
"by_minute": 21829
}
},
{
"type": "custom",
"color": "#5CF1D4",
"status": "active status #2",
"orderindex": 4,
"total_time": {
"since": "1602607941692",
"by_minute": 23274
}
}
]
}
]
}
AddDependencyrequest
{
"type": "object",
"title": "AddDependencyrequest",
"example": {
"depends_on": "9hw"
},
"properties": {
"depends_on": {
"type": "string"
},
"depedency_of": {
"type": "string"
}
},
"x-examples": [
{
"depends_on": "9hw"
}
]
}
AddGuestToFolderrequest
{
"type": "object",
"title": "AddGuestToFolderrequest",
"example": {
"permission_level": "read"
},
"required": [
"permission_level"
],
"properties": {
"permission_level": {
"type": "string",
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
}
},
"x-examples": [
{
"permission_level": "read"
}
]
}
AddGuestToFolderresponse
{
"type": "object",
"title": "AddGuestToFolderresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest5"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
AddGuestToListrequest
{
"type": "object",
"title": "AddGuestToListrequest",
"example": {
"permission_level": "read"
},
"required": [
"permission_level"
],
"properties": {
"permission_level": {
"type": "string",
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
}
},
"x-examples": [
{
"permission_level": "read"
}
]
}
AddGuestToListresponse
{
"type": "object",
"title": "AddGuestToListresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest3"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
AddGuestToTaskrequest
{
"type": "object",
"title": "AddGuestToTaskrequest",
"example": {
"permission_level": "read"
},
"required": [
"permission_level"
],
"properties": {
"permission_level": {
"type": "string",
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
}
},
"x-examples": [
{
"permission_level": "read"
}
]
}
AddGuestToTaskresponse
{
"type": "object",
"title": "AddGuestToTaskresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [
{
"id": "c04X",
"url": "https://app.clickup.com/t/c04",
"list": {
"id": "1752X",
"name": "Shared with me",
"access": false
},
"name": "Task Name",
"tags": [],
"space": {
"id": "380X"
},
"folder": {
"id": "1217X",
"name": "Shared with me",
"access": false,
"hidden": false
},
"parent": null,
"points": null,
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
"creator": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"team_id": "108",
"archived": false,
"due_date": "1508369194377",
"priority": {
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
},
"assignees": [],
"checklists": [],
"orderindex": "0",
"start_date": null,
"date_closed": null,
"date_created": "1574718405408",
"date_updated": "1574722145869",
"dependencies": [],
"custom_fields": [],
"time_estimate": null,
"permission_level": "read"
}
],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest1"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [
{
"id": "c04X",
"url": "https://app.clickup.com/t/c04",
"list": {
"id": "1752X",
"name": "Shared with me",
"access": false
},
"name": "Task Name",
"tags": [],
"space": {
"id": "380X"
},
"folder": {
"id": "1217X",
"name": "Shared with me",
"access": false,
"hidden": false
},
"parent": null,
"points": null,
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
"creator": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"team_id": "108",
"archived": false,
"due_date": "1508369194377",
"priority": {
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
},
"assignees": [],
"checklists": [],
"orderindex": "0",
"start_date": null,
"date_closed": null,
"date_created": "1574718405408",
"date_updated": "1574722145869",
"dependencies": [],
"custom_fields": [],
"time_estimate": null,
"permission_level": "read"
}
],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
AddTaskLinkresponse
{
"type": "object",
"title": "AddTaskLinkresponse",
"example": {
"task": {
"id": "9hvX",
"url": "https://app.clickup.com/t/9hx",
"list": {
"id": "123X"
},
"name": "Task Name",
"tags": [],
"space": {
"id": "789X"
},
"folder": {
"id": "456X"
},
"parent": null,
"status": {
"type": "custom",
"color": "#d3d3d3",
"status": "in progress",
"orderindex": 1
},
"creator": {
"id": 183,
"color": "#827718",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"due_date": null,
"priority": null,
"assignees": [],
"checklists": [],
"orderindex": "1.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"linked_tasks": [
{
"userid": "183",
"link_id": "9hz",
"task_id": "9hv",
"date_created": "1587571108988"
}
],
"time_estimate": null
}
},
"required": [
"task"
],
"properties": {
"task": {
"$ref": "#/components/schemas/Task"
}
},
"x-examples": [
{
"task": {
"id": "9hvX",
"url": "https://app.clickup.com/t/9hx",
"list": {
"id": "123X"
},
"name": "Task Name",
"tags": [],
"space": {
"id": "789X"
},
"folder": {
"id": "456X"
},
"parent": null,
"status": {
"type": "custom",
"color": "#d3d3d3",
"status": "in progress",
"orderindex": 1
},
"creator": {
"id": 183,
"color": "#827718",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"due_date": null,
"priority": null,
"assignees": [],
"checklists": [],
"orderindex": "1.00000000000000000000000000000000",
"start_date": null,
"time_spent": null,
"date_closed": null,
"date_created": "1567780450202",
"date_updated": "1567780450202",
"linked_tasks": [
{
"userid": "183",
"link_id": "9hz",
"task_id": "9hv",
"date_created": "1587571108988"
}
],
"time_estimate": null
}
}
]
}
Addtagsfromtimeentriesrequest
{
"type": "object",
"title": "Addtagsfromtimeentriesrequest",
"example": {
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"time_entry_ids": [
"timer_id"
]
},
"required": [
"time_entry_ids",
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags6"
},
"description": ""
},
"time_entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"time_entry_ids": [
"timer_id"
]
}
]
}
AssignedBy
{
"type": "object",
"title": "AssignedBy",
"example": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"required": [
"id",
"username",
"initials",
"email",
"color",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
}
Assignee
{
"type": "object",
"title": "Assignee",
"example": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
]
}
Assignee3
{
"type": "object",
"title": "Assignee3",
"example": {
"id": 183,
"color": "#827718",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"required": [
"id",
"color",
"username",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
]
}
Assignees
{
"type": "object",
"title": "Assignees",
"example": {
"add": [
182
],
"rem": [
183
]
},
"required": [
"add",
"rem"
],
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"rem": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"x-examples": [
{
"add": [
182
],
"rem": [
183
]
}
]
}
Assignees1
{
"type": "object",
"title": "Assignees1",
"example": {
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
},
"required": [
"id",
"username",
"color",
"email",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 123,
"color": "#000000",
"email": "johndoe@website.com",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
]
}
Attachment
{
"type": "object",
"title": "Attachment",
"example": {
"id": "62447c77-2086-4cda-b274-f53eccf0547b.csv",
"url": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"date": 1711570108374,
"size": 140970,
"type": 1,
"user": [
{
"id": [
{
"type": "integer",
"contentEncoding": "int32"
}
],
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
}
],
"title": "Canny - Exported posts - 2024-03-09.csv",
"hidden": false,
"source": 1,
"deleted": false,
"version": 0,
"mimetype": "text/csv",
"extension": "csv",
"is_folder": null,
"parent_id": "36fjfqy",
"email_data": null,
"url_w_host": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"orientation": null,
"url_w_query": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv?view=open",
"total_comments": 0,
"thumbnail_large": null,
"thumbnail_small": null,
"thumbnail_medium": null,
"resolved_comments": 0
},
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"date": {
"type": "bigint"
},
"size": {
"type": "bigint"
},
"type": {
"type": "int"
},
"user": {
"$ref": "#/components/schemas/User2",
"type": "string"
},
"title": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"source": {
"type": "int"
},
"deleted": {
"type": "boolean"
},
"version": {
"type": "int"
},
"mimetype": {
"type": "string"
},
"extension": {
"type": "string"
},
"is_folder": {
"type": "boolean"
},
"parent_id": {
"type": "string"
},
"email_data": {
"type": "object"
},
"url_w_host": {
"type": "string"
},
"orientation": {
"type": "string"
},
"url_w_query": {
"type": "string"
},
"total_comments": {
"type": "int"
},
"thumbnail_large": {
"type": "string"
},
"thumbnail_small": {
"type": "string"
},
"thumbnail_medium": {
"type": "string"
},
"resolved_comments": {
"type": "int"
}
},
"x-examples": [
{
"id": "62447c77-2086-4cda-b274-f53eccf0547b.csv",
"url": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"date": 1711570108374,
"size": 140970,
"type": 1,
"user": [
{
"id": [
{
"type": "integer",
"contentEncoding": "int32"
}
],
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
}
],
"title": "Canny - Exported posts - 2024-03-09.csv",
"hidden": false,
"source": 1,
"deleted": false,
"version": 0,
"mimetype": "text/csv",
"extension": "csv",
"is_folder": null,
"parent_id": "36fjfqy",
"email_data": null,
"url_w_host": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"orientation": null,
"url_w_query": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv?view=open",
"total_comments": 0,
"thumbnail_large": null,
"thumbnail_small": null,
"thumbnail_medium": null,
"resolved_comments": 0
}
]
}
AttachmentsUploadFileToTaskAsAttachmentRequest
{
"properties": {
"attachment": {
"type": "array",
"items": {}
}
}
}
Avatar
{
"type": "object",
"title": "Avatar",
"example": {
"icon": null,
"color": null,
"source": null,
"attachment_id": null
},
"required": [
"attachment_id",
"color",
"source",
"icon"
],
"properties": {
"icon": {
"type": [
"string",
"null"
]
},
"color": {
"type": [
"string",
"null"
]
},
"source": {
"type": [
"string",
"null"
]
},
"attachment_id": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"icon": null,
"color": null,
"source": null,
"attachment_id": null
}
]
}
Changetagnamesfromtimeentriesrequest
{
"type": "object",
"title": "Changetagnamesfromtimeentriesrequest",
"example": {
"name": "old tag name",
"tag_bg": "#000000",
"tag_fg": "#000000",
"new_name": "new tag name"
},
"required": [
"name",
"new_name",
"tag_bg",
"tag_fg"
],
"properties": {
"name": {
"type": "string"
},
"tag_bg": {
"type": "string"
},
"tag_fg": {
"type": "string"
},
"new_name": {
"type": "string"
}
},
"x-examples": [
{
"name": "old tag name",
"tag_bg": "#000000",
"tag_fg": "#000000",
"new_name": "new tag name"
}
]
}
Checklist
{
"type": "object",
"title": "Checklist",
"example": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [],
"task_id": "9hz",
"resolved": 0,
"orderindex": 0,
"unresolved": 0
},
"required": [
"id",
"task_id",
"name",
"orderindex",
"resolved",
"unresolved",
"items"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"task_id": {
"type": "string"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [],
"task_id": "9hz",
"resolved": 0,
"orderindex": 0,
"unresolved": 0
}
]
}
Checklist1
{
"type": "object",
"title": "Checklist1",
"example": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 0,
"orderindex": 0,
"unresolved": 1,
"date_created": "1567711563204"
},
"required": [
"id",
"task_id",
"name",
"date_created",
"orderindex",
"resolved",
"unresolved",
"items"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
},
"description": ""
},
"task_id": {
"type": "string"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 0,
"orderindex": 0,
"unresolved": 1,
"date_created": "1567711563204"
}
]
}
Checklist2
{
"type": "object",
"title": "Checklist2",
"example": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"children": [],
"resolved": true,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 1,
"orderindex": 0,
"unresolved": 0,
"date_created": "1567711563204"
},
"required": [
"id",
"task_id",
"name",
"date_created",
"orderindex",
"resolved",
"unresolved",
"items"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item1"
},
"description": ""
},
"task_id": {
"type": "string"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Updated Checklist Item",
"parent": null,
"assignee": null,
"children": [],
"resolved": true,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 1,
"orderindex": 0,
"unresolved": 0,
"date_created": "1567711563204"
}
]
}
Checklists
{
"type": "object",
"title": "Checklists",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
Checklists6
{
"type": "object",
"title": "Checklists6",
"example": {
"id": "d41340bc-2f17-43cc-ae71-86628f45825fX",
"name": "Checklist",
"items": [
{
"id": "9398cb3d-55a4-4c45-ab46-2a47a371e375X",
"name": "checklist item 1",
"parent": null,
"assignee": null,
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1618455810454"
}
],
"creator": 2770032,
"task_id": "3cxv9f",
"resolved": 0,
"orderindex": 1,
"unresolved": 1,
"date_created": "1618455803730"
},
"required": [
"id",
"task_id",
"name",
"date_created",
"orderindex",
"creator",
"resolved",
"unresolved",
"items"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item1"
},
"description": ""
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"task_id": {
"type": "string"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
}
},
"x-examples": [
{
"id": "d41340bc-2f17-43cc-ae71-86628f45825fX",
"name": "Checklist",
"items": [
{
"id": "9398cb3d-55a4-4c45-ab46-2a47a371e375X",
"name": "checklist item 1",
"parent": null,
"assignee": null,
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1618455810454"
}
],
"creator": 2770032,
"task_id": "3cxv9f",
"resolved": 0,
"orderindex": 1,
"unresolved": 1,
"date_created": "1618455803730"
}
]
}
Columns
{
"type": "object",
"title": "Columns",
"example": {
"fields": []
},
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom Fields require the `_cf` prefix and must be formatted as a JSON object."
}
},
"x-examples": [
{
"fields": []
}
],
"description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy."
}
Comment
{
"type": "object",
"title": "Comment",
"example": {
"id": "458X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "Task comment content"
}
],
"assignee": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"reactions": [],
"assigned_by": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment_text": "Task comment content"
},
"required": [
"id",
"comment",
"comment_text",
"user",
"resolved",
"assignee",
"assigned_by",
"reactions",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User2"
},
"comment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment1"
},
"description": ""
},
"assignee": {
"$ref": "#/components/schemas/Assignee"
},
"resolved": {
"type": "boolean"
},
"reactions": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"assigned_by": {
"$ref": "#/components/schemas/AssignedBy"
},
"comment_text": {
"type": "string"
}
},
"x-examples": [
{
"id": "458X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "Task comment content"
}
],
"assignee": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"reactions": [],
"assigned_by": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment_text": "Task comment content"
}
]
}
Comment1
{
"type": "object",
"title": "Comment1",
"example": {
"text": "Task comment content"
},
"required": [
"text"
],
"properties": {
"text": {
"type": "string"
}
},
"x-examples": [
{
"text": "Task comment content"
}
]
}
Comment2
{
"type": "object",
"title": "Comment2",
"example": {
"id": "459X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "View comment content"
}
],
"assignee": null,
"resolved": false,
"reactions": [],
"assigned_by": null,
"comment_text": "View comment content"
},
"required": [
"id",
"comment",
"comment_text",
"user",
"resolved",
"assignee",
"assigned_by",
"reactions",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/User2"
},
"comment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment1"
},
"description": ""
},
"assignee": {
"type": [
"string",
"null"
]
},
"resolved": {
"type": "boolean"
},
"reactions": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"assigned_by": {
"type": [
"string",
"null"
]
},
"comment_text": {
"type": "string"
}
},
"x-examples": [
{
"id": "459X",
"date": "1568036964079",
"user": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"comment": [
{
"text": "View comment content"
}
],
"assignee": null,
"resolved": false,
"reactions": [],
"assigned_by": null,
"comment_text": "View comment content"
}
]
}
CommentsDeleteTaskCommentResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
CommentsUpdateTaskCommentResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
CreateChatViewCommentrequest
{
"type": "object",
"title": "CreateChatViewCommentrequest",
"example": {
"notify_all": true,
"comment_text": "View comment content"
},
"required": [
"comment_text",
"notify_all"
],
"properties": {
"notify_all": {
"type": "boolean",
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."
},
"comment_text": {
"type": "string"
}
},
"x-examples": [
{
"notify_all": true,
"comment_text": "View comment content"
}
]
}
CreateChatViewCommentresponse
{
"type": "object",
"title": "CreateChatViewCommentresponse",
"example": {
"id": "459X",
"date": 1568037065216,
"hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae"
},
"required": [
"id",
"hist_id",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
},
"hist_id": {
"type": "string"
}
},
"x-examples": [
{
"id": "459X",
"date": 1568037065216,
"hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae"
}
]
}
CreateChecklistItemrequest
{
"type": "object",
"title": "CreateChecklistItemrequest",
"example": {
"name": "Checklist Item",
"assignee": 183
},
"properties": {
"name": {
"type": "string"
},
"assignee": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"name": "Checklist Item",
"assignee": 183
}
]
}
CreateChecklistItemresponse
{
"type": "object",
"title": "CreateChecklistItemresponse",
"example": {
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 0,
"orderindex": 0,
"unresolved": 1,
"date_created": "1567711563204"
}
},
"required": [
"checklist"
],
"properties": {
"checklist": {
"$ref": "#/components/schemas/Checklist1"
}
},
"x-examples": [
{
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6fX",
"name": "Checklist Item",
"parent": null,
"assignee": {
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
},
"children": [],
"resolved": false,
"orderindex": 0,
"date_created": "1567711566859"
}
],
"task_id": "9hv",
"resolved": 0,
"orderindex": 0,
"unresolved": 1,
"date_created": "1567711563204"
}
}
]
}
CreateChecklistrequest
{
"type": "object",
"title": "CreateChecklistrequest",
"example": {
"name": "Checklist"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
},
"x-examples": [
{
"name": "Checklist"
}
]
}
CreateChecklistresponse
{
"type": "object",
"title": "CreateChecklistresponse",
"example": {
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [],
"task_id": "9hz",
"resolved": 0,
"orderindex": 0,
"unresolved": 0
}
},
"required": [
"checklist"
],
"properties": {
"checklist": {
"$ref": "#/components/schemas/Checklist"
}
},
"x-examples": [
{
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683X",
"name": "Checklist",
"items": [],
"task_id": "9hz",
"resolved": 0,
"orderindex": 0,
"unresolved": 0
}
}
]
}
CreateFolderViewrequest
{
"type": "object",
"title": "CreateFolderViewrequest",
"example": {
"name": "New Folder View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
},
"required": [
"name",
"type",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
},
"divide": {
"$ref": "#/components/schemas/Divide"
},
"columns": {
"$ref": "#/components/schemas/Columns"
},
"filters": {
"$ref": "#/components/schemas/Filters"
},
"sorting": {
"$ref": "#/components/schemas/Sorting"
},
"grouping": {
"$ref": "#/components/schemas/Grouping"
},
"settings": {
"$ref": "#/components/schemas/Settings"
},
"team_sidebar": {
"$ref": "#/components/schemas/TeamSidebar"
}
},
"x-examples": [
{
"name": "New Folder View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
]
}
CreateFolderViewresponse
{
"type": "object",
"title": "CreateFolderViewresponse",
"example": {
"view": {
"id": "3c-107X",
"name": "New Folder View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "457X",
"type": 5
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
},
"required": [
"view"
],
"properties": {
"view": {
"$ref": "#/components/schemas/View"
}
},
"x-examples": [
{
"view": {
"id": "3c-107X",
"name": "New Folder View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"parent": {
"id": "457X",
"type": 5
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
}
]
}
CreateFolderlessListrequest
{
"type": "object",
"title": "CreateFolderlessListrequest",
"example": {
"name": "New List Name",
"status": "red",
"content": "New List Content",
"assignee": 183,
"due_date": 1567780450202,
"priority": 1,
"due_date_time": false
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string",
"description": "**Status** refers to the List color rather than the task Statuses available in the List."
},
"content": {
"type": "string"
},
"assignee": {
"type": "integer",
"description": "Include a `user_id` to add a List owner.",
"contentEncoding": "int32"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"due_date_time": {
"type": "boolean"
}
},
"x-examples": [
{
"name": "New List Name",
"status": "red",
"content": "New List Content",
"assignee": 183,
"due_date": 1567780450202,
"priority": 1,
"due_date_time": false
}
]
}
CreateFolderlessListresponse
{
"type": "object",
"title": "CreateFolderlessListresponse",
"example": {
"id": "124X",
"name": "New List Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"folder": {
"id": "457X",
"name": "hidden",
"access": true,
"hidden": true
},
"status": {
"color": "#e50000",
"status": "red",
"hide_label": true
},
"content": "New List Content",
"assignee": {
"id": 183,
"color": "#827718",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "urgent"
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"orderindex": 1,
"start_date": null,
"task_count": null,
"due_date_time": false,
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
"start_date_time": null
},
"required": [
"id",
"name",
"orderindex",
"content",
"status",
"priority",
"assignee",
"task_count",
"due_date",
"due_date_time",
"start_date",
"start_date_time",
"folder",
"space",
"statuses",
"inbound_address"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"space": {
"$ref": "#/components/schemas/Space2"
},
"folder": {
"$ref": "#/components/schemas/Folder3"
},
"status": {
"$ref": "#/components/schemas/Status5"
},
"content": {
"type": "string"
},
"assignee": {
"$ref": "#/components/schemas/Assignee3"
},
"due_date": {
"type": "string"
},
"priority": {
"$ref": "#/components/schemas/Priority1"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Status"
},
"description": ""
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"start_date": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": [
"string",
"null"
]
},
"due_date_time": {
"type": "boolean"
},
"inbound_address": {
"type": "string"
},
"start_date_time": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": "124X",
"name": "New List Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"folder": {
"id": "457X",
"name": "hidden",
"access": true,
"hidden": true
},
"status": {
"color": "#e50000",
"status": "red",
"hide_label": true
},
"content": "New List Content",
"assignee": {
"id": 183,
"color": "#827718",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"due_date": "1567780450202",
"priority": {
"color": "#f50000",
"priority": "urgent"
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"orderindex": 1,
"start_date": null,
"task_count": null,
"due_date_time": false,
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
"start_date_time": null
}
]
}
CreateFolderrequest
{
"type": "object",
"title": "CreateFolderrequest",
"example": {
"name": "New Folder Name"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
},
"x-examples": [
{
"name": "New Folder Name"
}
]
}
CreateFolderresponse
{
"type": "object",
"title": "CreateFolderresponse",
"example": {
"id": "457X",
"name": "New Folder Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
},
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"space",
"task_count"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"space": {
"$ref": "#/components/schemas/Space2"
},
"hidden": {
"type": "boolean"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"task_count": {
"type": "string"
},
"override_statuses": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "457X",
"name": "New Folder Name",
"space": {
"id": "789X",
"name": "Space Name",
"access": true
},
"hidden": false,
"orderindex": 0,
"task_count": "0",
"override_statuses": false
}
]
}
CreateGoalrequest
{
"type": "object",
"title": "CreateGoalrequest",
"example": {
"name": "Goal Name",
"color": "#32a852",
"owners": [
183
],
"due_date": 1568036964079,
"description": "Goal Description",
"multiple_owners": true
},
"required": [
"name",
"due_date",
"description",
"multiple_owners",
"owners",
"color"
],
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": "Array of user IDs."
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"description": {
"type": "string"
},
"multiple_owners": {
"type": "boolean"
}
},
"x-examples": [
{
"name": "Goal Name",
"color": "#32a852",
"owners": [
183
],
"due_date": 1568036964079,
"description": "Goal Description",
"multiple_owners": true
}
]
}
CreateGoalresponse
{
"type": "object",
"title": "CreateGoalresponse",
"example": {
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal Name",
"color": "#32a852",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
}
},
"required": [
"goal"
],
"properties": {
"goal": {
"$ref": "#/components/schemas/Goal"
}
},
"x-examples": [
{
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930X",
"name": "Goal Name",
"color": "#32a852",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
],
"creator": 183,
"history": [],
"members": [],
"private": false,
"team_id": "512",
"archived": false,
"due_date": "1568036964079",
"folder_id": null,
"pretty_id": "6",
"pretty_url": "https://app.clickup.com/512/goals/6",
"start_date": null,
"description": "Goal Description",
"key_results": [],
"date_created": "1568044355026",
"multiple_owners": true,
"percent_completed": 0
}
}
]
}
CreateKeyResultrequest
{
"type": "object",
"title": "CreateKeyResultrequest",
"example": {
"name": "New Target Name",
"type": "number",
"unit": "km",
"owners": [
183
],
"list_ids": [],
"task_ids": [],
"steps_end": 10,
"steps_start": 0
},
"required": [
"name",
"owners",
"type",
"steps_start",
"steps_end",
"unit",
"task_ids",
"list_ids"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`."
},
"unit": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"list_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enter an array of List IDs to link this target with one or more Lists."
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enter an array of task IDs to link this target with one or more tasks."
},
"steps_end": {
"type": "integer",
"contentEncoding": "int32"
},
"steps_start": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"name": "New Target Name",
"type": "number",
"unit": "km",
"owners": [
183
],
"list_ids": [],
"task_ids": [],
"steps_end": 10,
"steps_start": 0
}
]
}
CreateKeyResultresponse
{
"type": "object",
"title": "CreateKeyResultresponse",
"example": {
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
"note": "Created Key Result",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568062902048",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"steps_current": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
}
},
"required": [
"key_result"
],
"properties": {
"key_result": {
"$ref": "#/components/schemas/KeyResult"
}
},
"x-examples": [
{
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93X",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"owners": [
{
"id": 183,
"color": "#827718",
"email": "example@email.com",
"initials": "JK",
"username": "John Doe",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg"
}
],
"creator": 183,
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"task_ids": [],
"completed": false,
"last_action": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269X",
"note": "Created Key Result",
"userid": 183,
"steps_taken": null,
"steps_before": null,
"date_modified": "1568062902048",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"steps_current": null
},
"date_created": "1568062902048",
"goal_pretty_id": "6",
"subcategory_ids": [],
"percent_completed": null
}
}
]
}
CreateListCommentrequest
{
"type": "object",
"title": "CreateListCommentrequest",
"example": {
"assignee": 183,
"notify_all": true,
"comment_text": "List comment content"
},
"required": [
"comment_text",
"assignee",
"notify_all"
],
"properties": {
"assignee": {
"type": "integer",
"contentEncoding": "int32"
},
"notify_all": {
"type": "boolean",
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."
},
"comment_text": {
"type": "string"
}
},
"x-examples": [
{
"assignee": 183,
"notify_all": true,
"comment_text": "List comment content"
}
]
}
CreateListCommentresponse
{
"type": "object",
"title": "CreateListCommentresponse",
"example": {
"id": "462X",
"date": 1568037341249,
"hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08"
},
"required": [
"id",
"hist_id",
"date"
],
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
},
"hist_id": {
"type": "string"
}
},
"x-examples": [
{
"id": "462X",
"date": 1568037341249,
"hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08"
}
]
}
CreateListViewrequest
{
"type": "object",
"title": "CreateListViewrequest",
"example": {
"name": "New List View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
},
"required": [
"name",
"type",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
},
"divide": {
"$ref": "#/components/schemas/Divide"
},
"columns": {
"$ref": "#/components/schemas/Columns"
},
"filters": {
"$ref": "#/components/schemas/Filters"
},
"sorting": {
"$ref": "#/components/schemas/Sorting"
},
"grouping": {
"$ref": "#/components/schemas/Grouping"
},
"settings": {
"$ref": "#/components/schemas/Settings"
},
"team_sidebar": {
"$ref": "#/components/schemas/TeamSidebar"
}
},
"x-examples": [
{
"name": "New List View Name",
"type": "list",
"divide": {
"dir": null,
"field": null,
"collapsed": []
},
"columns": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"sorting": {
"fields": []
},
"grouping": {
"dir": 1,
"field": "status",
"ignore": false,
"collapsed": []
},
"settings": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"team_sidebar": {
"assignees": [],
"unassigned_tasks": false,
"assigned_comments": false
}
}
]
}