/clickup-collaboration | Type: Application | PCID required: Yes
Tools
clickup_collaboration_add_guest_to_folder
Add Guest To Folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
folder_id | number | Yes | — | Folder Id |
guest_id | number | Yes | — | Guest Id |
include_shared | boolean | No | — | Exclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true. |
permission_level | string | Yes | — | Can be read (view only), comment, edit, or create (full). |
clickup_collaboration_add_guest_to_list
Add Guest To List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | number | Yes | — | List Id |
guest_id | number | Yes | — | Guest Id |
include_shared | boolean | No | — | Exclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true. |
permission_level | string | Yes | — | Can be read (view only), comment, edit, or create (full). |
clickup_collaboration_add_guest_to_task
Add Guest To Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
guest_id | number | Yes | — | Guest Id |
include_shared | boolean | No | — | 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 | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
permission_level | string | Yes | — | Can be read (view only), comment, edit, or create (full). |
clickup_collaboration_create_chat_view_comment
Create Chat View Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
view_id | string | Yes | — | 105 (string) |
comment_text | string | Yes | — | Comment Text |
notify_all | boolean | Yes | — | If notify_all is true, the creator of the comment will also be notified. Other assignees and watchers on the view are always notified regardless of this setting. |
clickup_collaboration_create_goal
Create Goal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
color | string | Yes | — | The color value |
description | string | Yes | — | The description value |
due_date | integer | Yes | — | Due Date |
multiple_owners | boolean | Yes | — | Multiple Owners |
name | string | Yes | — | The name value |
owners | integer[] | Yes | — | Array of user IDs. |
clickup_collaboration_create_key_result
Create Key Result Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
goal_id | string | Yes | — | 900e-462d-a849-4a216b06d930 (uuid) |
list_ids | string[] | Yes | — | Enter an array of List IDs to link this target with one or more Lists. |
name | string | Yes | — | The name value |
owners | integer[] | Yes | — | The owners value |
steps_end | integer | Yes | — | Steps End |
steps_start | integer | Yes | — | Steps Start |
task_ids | string[] | Yes | — | Enter an array of task IDs to link this target with one or more tasks. |
type | string | Yes | — | Target (key result) types include: number, currency, boolean, percentage, or automatic. |
unit | string | Yes | — | The unit value |
clickup_collaboration_create_list_comment
Create List Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | number | Yes | — | List Id |
assignee | integer | Yes | — | The assignee value |
comment_text | string | Yes | — | Comment Text |
notify_all | boolean | Yes | — | If notify_all is true, the creator of the comment will also be notified. Other assignees and watchers on the List are always notified regardless of this setting. |
clickup_collaboration_create_task_comment
Create Task Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
assignee | integer | No | — | The assignee value |
comment_text | string | Yes | — | Comment Text |
group_assignee | string | No | — | Group Assignee |
notify_all | boolean | Yes | — | If notify_all is true, the creator of the comment will also be notified. Other assignees and watchers on the task are always notified regardless of this setting. |
clickup_collaboration_create_threaded_comment
Create Threaded Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
comment_id | number | Yes | — | Comment Id |
assignee | integer | No | — | The assignee value |
comment_text | string | Yes | — | Comment Text |
group_assignee | string | No | — | Group Assignee |
notify_all | boolean | Yes | — | If notify_all is true, the creator of the comment will also be notified. Other assignees and watchers on the task are always notified regardless of this setting. |
clickup_collaboration_create_user_group
Create Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
handle | string | No | — | The handle value |
members | integer[] | Yes | — | The members value |
name | string | Yes | — | The name value |
clickup_collaboration_delete_comment
Delete Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
comment_id | number | Yes | — | Comment Id |
clickup_collaboration_delete_goal
Delete Goal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
goal_id | string | Yes | — | 900e-462d-a849-4a216b06d930 (uuid) |
clickup_collaboration_delete_key_result
Delete Key Result Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key_result_id | string | Yes | — | 8480-49bc-8c57-e569747efe93 (uuid) |
clickup_collaboration_delete_team
Delete Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | User Group ID |
clickup_collaboration_edit_guest_on_workspace
Edit Guest On Workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
guest_id | number | Yes | — | Guest Id |
can_create_views | boolean | No | — | Can Create Views |
can_edit_tags | boolean | No | — | Can Edit Tags |
can_see_points_estimated | boolean | No | — | Can See Points Estimated |
can_see_time_estimated | boolean | No | — | Can See Time Estimated |
can_see_time_spent | boolean | No | — | Can See Time Spent |
custom_role_id | integer | No | — | Custom Role Id |
clickup_collaboration_edit_key_result
Edit Key Result Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key_result_id | string | Yes | — | 8480-49bc-8c57-e569747efe93 (uuid) |
note | string | No | — | The note value |
steps_current | integer | No | — | Steps Current |
clickup_collaboration_edit_user_on_workspace
Edit User On Workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
user_id | number | Yes | — | User Id |
admin | boolean | No | — | The admin value |
custom_role_id | integer | No | — | Custom Role Id |
username | string | No | — | The username value |
clickup_collaboration_get_chat_view_comments
Get Chat View Comments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
view_id | string | Yes | — | 105 (string) |
start | integer | No | — | Enter the date of a Chat view comment using Unix time in milliseconds. |
start_id | string | No | — | Enter the Comment id of a Chat view comment. |
clickup_collaboration_get_custom_roles
Get Custom Roles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
include_members | boolean | No | — | Include Members |
clickup_collaboration_get_goal
Get Goal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
goal_id | string | Yes | — | 900e-462d-a849-4a216b06d930 (uuid) |
clickup_collaboration_get_goals
Get Goals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
include_completed | boolean | No | — | Include Completed |
clickup_collaboration_get_guest
Get Guest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
guest_id | number | Yes | — | Guest Id |
clickup_collaboration_get_list_comments
Get List Comments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | number | Yes | — | List Id |
start | integer | No | — | Enter the date of a List info comment using Unix time in milliseconds. |
start_id | string | No | — | Enter the Comment id of a List info comment. |
clickup_collaboration_get_list_members
Get List Members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | number | Yes | — | List Id |
clickup_collaboration_get_task_comments
Get Task Comments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
start | integer | No | — | The Unix timestamp (in milliseconds) of the reference comment. Required for pagination. Must be used in combination with start_id. \ Value should be the date of the last comment from the previous response. |
start_id | string | No | — | The unique ID of the reference comment. Required for pagination. Must be used in combination with start. \ Value should be the id of the last comment from the previous response. |
clickup_collaboration_get_task_members
Get Task Members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
clickup_collaboration_get_teams1
Get Groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID. Note: For this endpoint, `team_id“ is a required query parameter. |
group_ids | string[] | No | — | Enter one or more User Group IDs to retrieve information about specific User Group(s).\ \ For example: \ \ ?team_id=12456&group_ids=ABC12345&group_ids=DEF98765 |
clickup_collaboration_get_threaded_comments
Get Threaded Comments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
comment_id | number | Yes | — | Comment Id |
clickup_collaboration_get_user
Get User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
user_id | number | Yes | — | User Id |
include_shared | boolean | No | — | Exclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true. |
clickup_collaboration_invite_guest_to_workspace
Invite Guest To Workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
can_create_views | boolean | No | — | Can Create Views |
can_edit_tags | boolean | No | — | Can Edit Tags |
can_see_points_estimated | boolean | No | — | Can See Points Estimated |
can_see_time_estimated | boolean | No | — | Can See Time Estimated |
can_see_time_spent | boolean | No | — | Can See Time Spent |
custom_role_id | integer | No | — | Custom Role Id |
email | string | Yes | — | The email value |
clickup_collaboration_invite_user_to_workspace
Invite User To Workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
admin | boolean | Yes | — | The admin value |
custom_role_id | integer | No | — | Custom Role Id |
email | string | Yes | — | The email value |
clickup_collaboration_remove_guest_from_folder
Remove Guest From Folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
folder_id | number | Yes | — | Folder Id |
guest_id | number | Yes | — | Guest Id |
include_shared | boolean | No | — | Exclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true. |
clickup_collaboration_remove_guest_from_list
Remove Guest From List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | number | Yes | — | List Id |
guest_id | number | Yes | — | Guest Id |
include_shared | boolean | No | — | Exclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true. |
clickup_collaboration_remove_guest_from_task
Remove Guest From Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
guest_id | number | Yes | — | Guest Id |
include_shared | boolean | No | — | 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 | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_collaboration_remove_guest_from_workspace
Remove Guest From Workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
guest_id | number | Yes | — | Guest Id |
clickup_collaboration_remove_user_from_workspace
Remove User From Workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
user_id | number | Yes | — | User Id |
clickup_collaboration_update_comment
Update Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
comment_id | number | Yes | — | Comment Id |
assignee | integer | No | — | The assignee value |
comment_text | string | No | — | Comment Text |
group_assignee | integer | No | — | Group Assignee |
resolved | boolean | No | — | The resolved value |
clickup_collaboration_update_goal
Update Goal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
goal_id | string | Yes | — | 900e-462d-a849-4a216b06d930 (uuid) |
add_owners | integer[] | No | — | Array of user IDs. |
color | string | No | — | The color value |
description | string | No | — | The description value |
due_date | integer | No | — | Due Date |
name | string | No | — | The name value |
rem_owners | integer[] | No | — | Array of user IDs. |
clickup_collaboration_update_team
Update Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | User Group ID |
handle | string | No | — | The handle value |
members | object | No | — | The members value |
name | string | No | — | The name value |

