> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# clickup-collaboration
> ClickUp Collaboration - Comments, goals, members, users, guests, and roles
**Server path:** `/clickup-collaboration` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------- | --------------------------- |
| [`clickup_collaboration_add_guest_to_folder`](#clickup_collaboration_add_guest_to_folder) | Add Guest To Folder |
| [`clickup_collaboration_add_guest_to_list`](#clickup_collaboration_add_guest_to_list) | Add Guest To List |
| [`clickup_collaboration_add_guest_to_task`](#clickup_collaboration_add_guest_to_task) | Add Guest To Task |
| [`clickup_collaboration_create_chat_view_comment`](#clickup_collaboration_create_chat_view_comment) | Create Chat View Comment |
| [`clickup_collaboration_create_goal`](#clickup_collaboration_create_goal) | Create Goal |
| [`clickup_collaboration_create_key_result`](#clickup_collaboration_create_key_result) | Create Key Result |
| [`clickup_collaboration_create_list_comment`](#clickup_collaboration_create_list_comment) | Create List Comment |
| [`clickup_collaboration_create_task_comment`](#clickup_collaboration_create_task_comment) | Create Task Comment |
| [`clickup_collaboration_create_threaded_comment`](#clickup_collaboration_create_threaded_comment) | Create Threaded Comment |
| [`clickup_collaboration_create_user_group`](#clickup_collaboration_create_user_group) | Create Group |
| [`clickup_collaboration_delete_comment`](#clickup_collaboration_delete_comment) | Delete Comment |
| [`clickup_collaboration_delete_goal`](#clickup_collaboration_delete_goal) | Delete Goal |
| [`clickup_collaboration_delete_key_result`](#clickup_collaboration_delete_key_result) | Delete Key Result |
| [`clickup_collaboration_delete_team`](#clickup_collaboration_delete_team) | Delete Group |
| [`clickup_collaboration_edit_guest_on_workspace`](#clickup_collaboration_edit_guest_on_workspace) | Edit Guest On Workspace |
| [`clickup_collaboration_edit_key_result`](#clickup_collaboration_edit_key_result) | Edit Key Result |
| [`clickup_collaboration_edit_user_on_workspace`](#clickup_collaboration_edit_user_on_workspace) | Edit User On Workspace |
| [`clickup_collaboration_get_chat_view_comments`](#clickup_collaboration_get_chat_view_comments) | Get Chat View Comments |
| [`clickup_collaboration_get_custom_roles`](#clickup_collaboration_get_custom_roles) | Get Custom Roles |
| [`clickup_collaboration_get_goal`](#clickup_collaboration_get_goal) | Get Goal |
| [`clickup_collaboration_get_goals`](#clickup_collaboration_get_goals) | Get Goals |
| [`clickup_collaboration_get_guest`](#clickup_collaboration_get_guest) | Get Guest |
| [`clickup_collaboration_get_list_comments`](#clickup_collaboration_get_list_comments) | Get List Comments |
| [`clickup_collaboration_get_list_members`](#clickup_collaboration_get_list_members) | Get List Members |
| [`clickup_collaboration_get_task_comments`](#clickup_collaboration_get_task_comments) | Get Task Comments |
| [`clickup_collaboration_get_task_members`](#clickup_collaboration_get_task_members) | Get Task Members |
| [`clickup_collaboration_get_teams1`](#clickup_collaboration_get_teams1) | Get Groups |
| [`clickup_collaboration_get_threaded_comments`](#clickup_collaboration_get_threaded_comments) | Get Threaded Comments |
| [`clickup_collaboration_get_user`](#clickup_collaboration_get_user) | Get User |
| [`clickup_collaboration_invite_guest_to_workspace`](#clickup_collaboration_invite_guest_to_workspace) | Invite Guest To Workspace |
| [`clickup_collaboration_invite_user_to_workspace`](#clickup_collaboration_invite_user_to_workspace) | Invite User To Workspace |
| [`clickup_collaboration_remove_guest_from_folder`](#clickup_collaboration_remove_guest_from_folder) | Remove Guest From Folder |
| [`clickup_collaboration_remove_guest_from_list`](#clickup_collaboration_remove_guest_from_list) | Remove Guest From List |
| [`clickup_collaboration_remove_guest_from_task`](#clickup_collaboration_remove_guest_from_task) | Remove Guest From Task |
| [`clickup_collaboration_remove_guest_from_workspace`](#clickup_collaboration_remove_guest_from_workspace) | Remove Guest From Workspace |
| [`clickup_collaboration_remove_user_from_workspace`](#clickup_collaboration_remove_user_from_workspace) | Remove User From Workspace |
| [`clickup_collaboration_update_comment`](#clickup_collaboration_update_comment) | Update Comment |
| [`clickup_collaboration_update_goal`](#clickup_collaboration_update_goal) | Update Goal |
| [`clickup_collaboration_update_team`](#clickup_collaboration_update_team) | Update Group |
***
## 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). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"folder_id": {
"type": "number",
"description": "Folder Id"
},
"guest_id": {
"type": "number",
"description": "Guest Id"
},
"include_shared": {
"type": "boolean",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."
},
"permission_level": {
"type": "string",
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
}
},
"required": [
"PCID",
"folder_id",
"guest_id",
"permission_level"
]
}
```
***
## 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). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "number",
"description": "List Id"
},
"guest_id": {
"type": "number",
"description": "Guest Id"
},
"include_shared": {
"type": "boolean",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."
},
"permission_level": {
"type": "string",
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
}
},
"required": [
"PCID",
"list_id",
"guest_id",
"permission_level"
]
}
```
***
## 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). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Task Id"
},
"guest_id": {
"type": "number",
"description": "Guest Id"
},
"include_shared": {
"type": "boolean",
"description": "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": {
"type": "boolean",
"description": "If you want to reference a task by it's custom task id, this value must be `true`."
},
"team_id": {
"type": "number",
"description": "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": {
"type": "string",
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)."
}
},
"required": [
"PCID",
"task_id",
"guest_id",
"permission_level"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"view_id": {
"type": "string",
"description": "105 (string)"
},
"comment_text": {
"type": "string",
"description": "Comment Text"
},
"notify_all": {
"type": "boolean",
"description": "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."
}
},
"required": [
"PCID",
"view_id",
"comment_text",
"notify_all"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"color": {
"type": "string",
"description": "The color value"
},
"description": {
"type": "string",
"description": "The description value"
},
"due_date": {
"type": "integer",
"description": "Due Date"
},
"multiple_owners": {
"type": "boolean",
"description": "Multiple Owners"
},
"name": {
"type": "string",
"description": "The name value"
},
"owners": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of user IDs."
}
},
"required": [
"PCID",
"team_id",
"color",
"description",
"due_date",
"multiple_owners",
"name",
"owners"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"goal_id": {
"type": "string",
"description": "900e-462d-a849-4a216b06d930 (uuid)"
},
"list_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enter an array of List IDs to link this target with one or more Lists."
},
"name": {
"type": "string",
"description": "The name value"
},
"owners": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The owners value"
},
"steps_end": {
"type": "integer",
"description": "Steps End"
},
"steps_start": {
"type": "integer",
"description": "Steps Start"
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enter an array of task IDs to link this target with one or more tasks."
},
"type": {
"type": "string",
"description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`."
},
"unit": {
"type": "string",
"description": "The unit value"
}
},
"required": [
"PCID",
"goal_id",
"list_ids",
"name",
"owners",
"steps_end",
"steps_start",
"task_ids",
"type",
"unit"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "number",
"description": "List Id"
},
"assignee": {
"type": "integer",
"description": "The assignee value"
},
"comment_text": {
"type": "string",
"description": "Comment Text"
},
"notify_all": {
"type": "boolean",
"description": "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."
}
},
"required": [
"PCID",
"list_id",
"assignee",
"comment_text",
"notify_all"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Task Id"
},
"custom_task_ids": {
"type": "boolean",
"description": "If you want to reference a task by it's custom task id, this value must be `true`."
},
"team_id": {
"type": "number",
"description": "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": {
"type": "integer",
"description": "The assignee value"
},
"comment_text": {
"type": "string",
"description": "Comment Text"
},
"group_assignee": {
"type": "string",
"description": "Group Assignee"
},
"notify_all": {
"type": "boolean",
"description": "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."
}
},
"required": [
"PCID",
"task_id",
"comment_text",
"notify_all"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"comment_id": {
"type": "number",
"description": "Comment Id"
},
"assignee": {
"type": "integer",
"description": "The assignee value"
},
"comment_text": {
"type": "string",
"description": "Comment Text"
},
"group_assignee": {
"type": "string",
"description": "Group Assignee"
},
"notify_all": {
"type": "boolean",
"description": "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."
}
},
"required": [
"PCID",
"comment_id",
"comment_text",
"notify_all"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"handle": {
"type": "string",
"description": "The handle value"
},
"members": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The members value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"team_id",
"members",
"name"
]
}
```
***
## clickup\_collaboration\_delete\_comment
Delete Comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `comment_id` | number | Yes | — | Comment Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"comment_id": {
"type": "number",
"description": "Comment Id"
}
},
"required": [
"PCID",
"comment_id"
]
}
```
***
## clickup\_collaboration\_delete\_goal
Delete Goal
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------- |
| `goal_id` | string | Yes | — | 900e-462d-a849-4a216b06d930 (uuid) |
| `Content-Type` | string | Yes | — | The content-type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"goal_id": {
"type": "string",
"description": "900e-462d-a849-4a216b06d930 (uuid)"
},
"Content-Type": {
"type": "string",
"description": "The content-type value"
}
},
"required": [
"PCID",
"goal_id",
"Content-Type"
]
}
```
***
## clickup\_collaboration\_delete\_key\_result
Delete Key Result
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------- |
| `key_result_id` | string | Yes | — | 8480-49bc-8c57-e569747efe93 (uuid) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key_result_id": {
"type": "string",
"description": "8480-49bc-8c57-e569747efe93 (uuid)"
}
},
"required": [
"PCID",
"key_result_id"
]
}
```
***
## clickup\_collaboration\_delete\_team
Delete Group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------- |
| `group_id` | string | Yes | — | User Group ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"group_id": {
"type": "string",
"description": "User Group ID"
}
},
"required": [
"PCID",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"guest_id": {
"type": "number",
"description": "Guest Id"
},
"can_create_views": {
"type": "boolean",
"description": "Can Create Views"
},
"can_edit_tags": {
"type": "boolean",
"description": "Can Edit Tags"
},
"can_see_points_estimated": {
"type": "boolean",
"description": "Can See Points Estimated"
},
"can_see_time_estimated": {
"type": "boolean",
"description": "Can See Time Estimated"
},
"can_see_time_spent": {
"type": "boolean",
"description": "Can See Time Spent"
},
"custom_role_id": {
"type": "integer",
"description": "Custom Role Id"
}
},
"required": [
"PCID",
"team_id",
"guest_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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key_result_id": {
"type": "string",
"description": "8480-49bc-8c57-e569747efe93 (uuid)"
},
"note": {
"type": "string",
"description": "The note value"
},
"steps_current": {
"type": "integer",
"description": "Steps Current"
}
},
"required": [
"PCID",
"key_result_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"user_id": {
"type": "number",
"description": "User Id"
},
"admin": {
"type": "boolean",
"description": "The admin value"
},
"custom_role_id": {
"type": "integer",
"description": "Custom Role Id"
},
"username": {
"type": "string",
"description": "The username value"
}
},
"required": [
"PCID",
"team_id",
"user_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"view_id": {
"type": "string",
"description": "105 (string)"
},
"start": {
"type": "integer",
"description": "Enter the `date` of a Chat view comment using Unix time in milliseconds."
},
"start_id": {
"type": "string",
"description": "Enter the Comment `id` of a Chat view comment."
}
},
"required": [
"PCID",
"view_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"include_members": {
"type": "boolean",
"description": "Include Members"
}
},
"required": [
"PCID",
"team_id"
]
}
```
***
## clickup\_collaboration\_get\_goal
Get Goal
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------- |
| `goal_id` | string | Yes | — | 900e-462d-a849-4a216b06d930 (uuid) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"goal_id": {
"type": "string",
"description": "900e-462d-a849-4a216b06d930 (uuid)"
}
},
"required": [
"PCID",
"goal_id"
]
}
```
***
## clickup\_collaboration\_get\_goals
Get Goals
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `team_id` | number | Yes | — | Workspace ID |
| `include_completed` | boolean | No | — | Include Completed |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"include_completed": {
"type": "boolean",
"description": "Include Completed"
}
},
"required": [
"PCID",
"team_id"
]
}
```
***
## clickup\_collaboration\_get\_guest
Get Guest
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------ |
| `team_id` | number | Yes | — | Workspace ID |
| `guest_id` | number | Yes | — | Guest Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"guest_id": {
"type": "number",
"description": "Guest Id"
}
},
"required": [
"PCID",
"team_id",
"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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "number",
"description": "List Id"
},
"start": {
"type": "integer",
"description": "Enter the `date` of a List info comment using Unix time in milliseconds."
},
"start_id": {
"type": "string",
"description": "Enter the Comment `id` of a List info comment."
}
},
"required": [
"PCID",
"list_id"
]
}
```
***
## clickup\_collaboration\_get\_list\_members
Get List Members
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `list_id` | number | Yes | — | List Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "number",
"description": "List Id"
}
},
"required": [
"PCID",
"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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Task Id"
},
"custom_task_ids": {
"type": "boolean",
"description": "If you want to reference a task by it's custom task id, this value must be `true`."
},
"team_id": {
"type": "number",
"description": "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": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"task_id"
]
}
```
***
## clickup\_collaboration\_get\_task\_members
Get Task Members
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `task_id` | string | Yes | — | Task Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Task Id"
}
},
"required": [
"PCID",
"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` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID. **Note**: For this endpoint, `team_id`` is a required query parameter."
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "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`"
}
},
"required": [
"PCID",
"team_id"
]
}
```
***
## clickup\_collaboration\_get\_threaded\_comments
Get Threaded Comments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `comment_id` | number | Yes | — | Comment Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"comment_id": {
"type": "number",
"description": "Comment Id"
}
},
"required": [
"PCID",
"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`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"user_id": {
"type": "number",
"description": "User Id"
},
"include_shared": {
"type": "boolean",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."
}
},
"required": [
"PCID",
"team_id",
"user_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"can_create_views": {
"type": "boolean",
"description": "Can Create Views"
},
"can_edit_tags": {
"type": "boolean",
"description": "Can Edit Tags"
},
"can_see_points_estimated": {
"type": "boolean",
"description": "Can See Points Estimated"
},
"can_see_time_estimated": {
"type": "boolean",
"description": "Can See Time Estimated"
},
"can_see_time_spent": {
"type": "boolean",
"description": "Can See Time Spent"
},
"custom_role_id": {
"type": "integer",
"description": "Custom Role Id"
},
"email": {
"type": "string",
"description": "The email value"
}
},
"required": [
"PCID",
"team_id",
"email"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"admin": {
"type": "boolean",
"description": "The admin value"
},
"custom_role_id": {
"type": "integer",
"description": "Custom Role Id"
},
"email": {
"type": "string",
"description": "The email value"
}
},
"required": [
"PCID",
"team_id",
"admin",
"email"
]
}
```
***
## 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`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"folder_id": {
"type": "number",
"description": "Folder Id"
},
"guest_id": {
"type": "number",
"description": "Guest Id"
},
"include_shared": {
"type": "boolean",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."
}
},
"required": [
"PCID",
"folder_id",
"guest_id"
]
}
```
***
## 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`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"list_id": {
"type": "number",
"description": "List Id"
},
"guest_id": {
"type": "number",
"description": "Guest Id"
},
"include_shared": {
"type": "boolean",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`."
}
},
"required": [
"PCID",
"list_id",
"guest_id"
]
}
```
***
## 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`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "Task Id"
},
"guest_id": {
"type": "number",
"description": "Guest Id"
},
"include_shared": {
"type": "boolean",
"description": "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": {
"type": "boolean",
"description": "If you want to reference a task by it's custom task id, this value must be `true`."
},
"team_id": {
"type": "number",
"description": "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`."
}
},
"required": [
"PCID",
"task_id",
"guest_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"guest_id": {
"type": "number",
"description": "Guest Id"
}
},
"required": [
"PCID",
"team_id",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_id": {
"type": "number",
"description": "Workspace ID"
},
"user_id": {
"type": "number",
"description": "User Id"
}
},
"required": [
"PCID",
"team_id",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"comment_id": {
"type": "number",
"description": "Comment Id"
},
"assignee": {
"type": "integer",
"description": "The assignee value"
},
"comment_text": {
"type": "string",
"description": "Comment Text"
},
"group_assignee": {
"type": "integer",
"description": "Group Assignee"
},
"resolved": {
"type": "boolean",
"description": "The resolved value"
}
},
"required": [
"PCID",
"comment_id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"goal_id": {
"type": "string",
"description": "900e-462d-a849-4a216b06d930 (uuid)"
},
"add_owners": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of user IDs."
},
"color": {
"type": "string",
"description": "The color value"
},
"description": {
"type": "string",
"description": "The description value"
},
"due_date": {
"type": "integer",
"description": "Due Date"
},
"name": {
"type": "string",
"description": "The name value"
},
"rem_owners": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of user IDs."
}
},
"required": [
"PCID",
"goal_id"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"group_id": {
"type": "string",
"description": "User Group ID"
},
"handle": {
"type": "string",
"description": "The handle value"
},
"members": {
"type": "object",
"description": "The members value",
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The add value"
},
"rem": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The rem value"
}
},
"required": [
"add",
"rem"
]
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"group_id"
]
}
```