Skip to main content
Server path: /clickup-collaboration | Type: Application | PCID required: Yes

Tools

ToolDescription
clickup_collaboration_add_guest_to_folderAdd Guest To Folder
clickup_collaboration_add_guest_to_listAdd Guest To List
clickup_collaboration_add_guest_to_taskAdd Guest To Task
clickup_collaboration_create_chat_view_commentCreate Chat View Comment
clickup_collaboration_create_goalCreate Goal
clickup_collaboration_create_key_resultCreate Key Result
clickup_collaboration_create_list_commentCreate List Comment
clickup_collaboration_create_task_commentCreate Task Comment
clickup_collaboration_create_threaded_commentCreate Threaded Comment
clickup_collaboration_create_user_groupCreate Group
clickup_collaboration_delete_commentDelete Comment
clickup_collaboration_delete_goalDelete Goal
clickup_collaboration_delete_key_resultDelete Key Result
clickup_collaboration_delete_teamDelete Group
clickup_collaboration_edit_guest_on_workspaceEdit Guest On Workspace
clickup_collaboration_edit_key_resultEdit Key Result
clickup_collaboration_edit_user_on_workspaceEdit User On Workspace
clickup_collaboration_get_chat_view_commentsGet Chat View Comments
clickup_collaboration_get_custom_rolesGet Custom Roles
clickup_collaboration_get_goalGet Goal
clickup_collaboration_get_goalsGet Goals
clickup_collaboration_get_guestGet Guest
clickup_collaboration_get_list_commentsGet List Comments
clickup_collaboration_get_list_membersGet List Members
clickup_collaboration_get_task_commentsGet Task Comments
clickup_collaboration_get_task_membersGet Task Members
clickup_collaboration_get_teams1Get Groups
clickup_collaboration_get_threaded_commentsGet Threaded Comments
clickup_collaboration_get_userGet User
clickup_collaboration_invite_guest_to_workspaceInvite Guest To Workspace
clickup_collaboration_invite_user_to_workspaceInvite User To Workspace
clickup_collaboration_remove_guest_from_folderRemove Guest From Folder
clickup_collaboration_remove_guest_from_listRemove Guest From List
clickup_collaboration_remove_guest_from_taskRemove Guest From Task
clickup_collaboration_remove_guest_from_workspaceRemove Guest From Workspace
clickup_collaboration_remove_user_from_workspaceRemove User From Workspace
clickup_collaboration_update_commentUpdate Comment
clickup_collaboration_update_goalUpdate Goal
clickup_collaboration_update_teamUpdate Group

clickup_collaboration_add_guest_to_folder

Add Guest To Folder Parameters:
ParameterTypeRequiredDefaultDescription
folder_idnumberYesFolder Id
guest_idnumberYesGuest Id
include_sharedbooleanNoExclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true.
permission_levelstringYesCan be read (view only), comment, edit, or create (full).

clickup_collaboration_add_guest_to_list

Add Guest To List Parameters:
ParameterTypeRequiredDefaultDescription
list_idnumberYesList Id
guest_idnumberYesGuest Id
include_sharedbooleanNoExclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true.
permission_levelstringYesCan be read (view only), comment, edit, or create (full).

clickup_collaboration_add_guest_to_task

Add Guest To Task Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
guest_idnumberYesGuest Id
include_sharedbooleanNoExclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true.
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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_levelstringYesCan be read (view only), comment, edit, or create (full).

clickup_collaboration_create_chat_view_comment

Create Chat View Comment Parameters:
ParameterTypeRequiredDefaultDescription
view_idstringYes105 (string)
comment_textstringYesComment Text
notify_allbooleanYesIf 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:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
colorstringYesThe color value
descriptionstringYesThe description value
due_dateintegerYesDue Date
multiple_ownersbooleanYesMultiple Owners
namestringYesThe name value
ownersinteger[]YesArray of user IDs.

clickup_collaboration_create_key_result

Create Key Result Parameters:
ParameterTypeRequiredDefaultDescription
goal_idstringYes900e-462d-a849-4a216b06d930 (uuid)
list_idsstring[]YesEnter an array of List IDs to link this target with one or more Lists.
namestringYesThe name value
ownersinteger[]YesThe owners value
steps_endintegerYesSteps End
steps_startintegerYesSteps Start
task_idsstring[]YesEnter an array of task IDs to link this target with one or more tasks.
typestringYesTarget (key result) types include: number, currency, boolean, percentage, or automatic.
unitstringYesThe unit value

clickup_collaboration_create_list_comment

Create List Comment Parameters:
ParameterTypeRequiredDefaultDescription
list_idnumberYesList Id
assigneeintegerYesThe assignee value
comment_textstringYesComment Text
notify_allbooleanYesIf 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:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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.
assigneeintegerNoThe assignee value
comment_textstringYesComment Text
group_assigneestringNoGroup Assignee
notify_allbooleanYesIf 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:
ParameterTypeRequiredDefaultDescription
comment_idnumberYesComment Id
assigneeintegerNoThe assignee value
comment_textstringYesComment Text
group_assigneestringNoGroup Assignee
notify_allbooleanYesIf 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:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
handlestringNoThe handle value
membersinteger[]YesThe members value
namestringYesThe name value

clickup_collaboration_delete_comment

Delete Comment Parameters:
ParameterTypeRequiredDefaultDescription
comment_idnumberYesComment Id

clickup_collaboration_delete_goal

Delete Goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_idstringYes900e-462d-a849-4a216b06d930 (uuid)

clickup_collaboration_delete_key_result

Delete Key Result Parameters:
ParameterTypeRequiredDefaultDescription
key_result_idstringYes8480-49bc-8c57-e569747efe93 (uuid)

clickup_collaboration_delete_team

Delete Group Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesUser Group ID

clickup_collaboration_edit_guest_on_workspace

Edit Guest On Workspace Parameters:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
guest_idnumberYesGuest Id
can_create_viewsbooleanNoCan Create Views
can_edit_tagsbooleanNoCan Edit Tags
can_see_points_estimatedbooleanNoCan See Points Estimated
can_see_time_estimatedbooleanNoCan See Time Estimated
can_see_time_spentbooleanNoCan See Time Spent
custom_role_idintegerNoCustom Role Id

clickup_collaboration_edit_key_result

Edit Key Result Parameters:
ParameterTypeRequiredDefaultDescription
key_result_idstringYes8480-49bc-8c57-e569747efe93 (uuid)
notestringNoThe note value
steps_currentintegerNoSteps Current

clickup_collaboration_edit_user_on_workspace

Edit User On Workspace Parameters:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
user_idnumberYesUser Id
adminbooleanNoThe admin value
custom_role_idintegerNoCustom Role Id
usernamestringNoThe username value

clickup_collaboration_get_chat_view_comments

Get Chat View Comments Parameters:
ParameterTypeRequiredDefaultDescription
view_idstringYes105 (string)
startintegerNoEnter the date of a Chat view comment using Unix time in milliseconds.
start_idstringNoEnter the Comment id of a Chat view comment.

clickup_collaboration_get_custom_roles

Get Custom Roles Parameters:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
include_membersbooleanNoInclude Members

clickup_collaboration_get_goal

Get Goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_idstringYes900e-462d-a849-4a216b06d930 (uuid)

clickup_collaboration_get_goals

Get Goals Parameters:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
include_completedbooleanNoInclude Completed

clickup_collaboration_get_guest

Get Guest Parameters:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
guest_idnumberYesGuest Id

clickup_collaboration_get_list_comments

Get List Comments Parameters:
ParameterTypeRequiredDefaultDescription
list_idnumberYesList Id
startintegerNoEnter the date of a List info comment using Unix time in milliseconds.
start_idstringNoEnter the Comment id of a List info comment.

clickup_collaboration_get_list_members

Get List Members Parameters:
ParameterTypeRequiredDefaultDescription
list_idnumberYesList Id

clickup_collaboration_get_task_comments

Get Task Comments Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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.
startintegerNoThe 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_idstringNoThe 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:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id

clickup_collaboration_get_teams1

Get Groups Parameters:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID. Note: For this endpoint, `team_id“ is a required query parameter.
group_idsstring[]NoEnter 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:
ParameterTypeRequiredDefaultDescription
comment_idnumberYesComment Id

clickup_collaboration_get_user

Get User Parameters:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
user_idnumberYesUser Id
include_sharedbooleanNoExclude 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:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
can_create_viewsbooleanNoCan Create Views
can_edit_tagsbooleanNoCan Edit Tags
can_see_points_estimatedbooleanNoCan See Points Estimated
can_see_time_estimatedbooleanNoCan See Time Estimated
can_see_time_spentbooleanNoCan See Time Spent
custom_role_idintegerNoCustom Role Id
emailstringYesThe email value

clickup_collaboration_invite_user_to_workspace

Invite User To Workspace Parameters:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
adminbooleanYesThe admin value
custom_role_idintegerNoCustom Role Id
emailstringYesThe email value

clickup_collaboration_remove_guest_from_folder

Remove Guest From Folder Parameters:
ParameterTypeRequiredDefaultDescription
folder_idnumberYesFolder Id
guest_idnumberYesGuest Id
include_sharedbooleanNoExclude 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:
ParameterTypeRequiredDefaultDescription
list_idnumberYesList Id
guest_idnumberYesGuest Id
include_sharedbooleanNoExclude 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:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
guest_idnumberYesGuest Id
include_sharedbooleanNoExclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true.
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
guest_idnumberYesGuest Id

clickup_collaboration_remove_user_from_workspace

Remove User From Workspace Parameters:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID
user_idnumberYesUser Id

clickup_collaboration_update_comment

Update Comment Parameters:
ParameterTypeRequiredDefaultDescription
comment_idnumberYesComment Id
assigneeintegerNoThe assignee value
comment_textstringNoComment Text
group_assigneeintegerNoGroup Assignee
resolvedbooleanNoThe resolved value

clickup_collaboration_update_goal

Update Goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_idstringYes900e-462d-a849-4a216b06d930 (uuid)
add_ownersinteger[]NoArray of user IDs.
colorstringNoThe color value
descriptionstringNoThe description value
due_dateintegerNoDue Date
namestringNoThe name value
rem_ownersinteger[]NoArray of user IDs.

clickup_collaboration_update_team

Update Group Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesUser Group ID
handlestringNoThe handle value
membersobjectNoThe members value
namestringNoThe name value