Overview
Configuration is provided for establishing connections with ClickUp service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Stripe ClickUp API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select ClickUp. You can either choose Token or OAuth 2 for the parameter Authentication in the grid below.
Step 3. If you have set the Authentication parameter to Token then in the grid below specify the API Token for parameter Token which can be retrieved from url : https://app.clickup.com/25732496/settings/apps. Then click on Test Connection to see if you have a successful connection or not to the ClickUp service and Ignore the steps 4 to 9. If the Authentciation parameter is set to OAUTH 2 then follow the steps 4 to 9 for successfuly generating the token file.
Step 4. If Authentication parameter is set to OAUTH 2 then in the grid below click on New to create a new token file.
Step 4. In the nex wizard choose option External Browser and hit next button.
Step 5. In the next wizard select workspace from the available workspace and then click on connect to workspace.
Step 6. In the next wizard copy the url which we will use to retrieve the access token.
Step 7. Paste the url in the token generation wizard we copied in the previous step and click on next button.
Step 7. Paste the url in the token generation wizard we copied in the previous step and click on next button.
Step 8: Save generated access token to file. Specify token protection password. Click OK.
Step 9. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your ClickUp instance.
In this guide, we will show how to read data from the ClickUp service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select ClickUp connection from the combo. Select from available ClickUp resources listed in the second combo below. Specify the Required parameter in the grid below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select ClickUp resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from ClicUp service.
In this guide, we will show how to write data to the ClickUp service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select ClickUp connection from the combo. Also, select resource action and ClickUP resource you want to work on. Specify the pameters in the grid below if they are required.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the ClickUp resource.
Configuration
Base URL address: https://app.clickup.com/api/v2.
- OAuth 2
-
The authentication uses an authorized token.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://clickup.com/api.
-
Authorization:
- Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Token:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=connection.user.Token}}
Documentation: https://clickup20.docs.apiary.io/#introduction/authentication/personal-token.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team.
The result is extracted from:{{=response.teams}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/teams-workspaces/get-teams.
- id
Template: ShortText.
- name
Template: ShortText.
- color
Template: ShortText.
- avatar
Template: ShortText.
- members
Field components:
- An array.
- Contains the following components: user, invited_by.
- seats
The value is gathered from
/team/{{=item.id}}/groupaddress. Field components:- Contains the following components: members, guests.
- views
The value is gathered from
/team/{{=item.id}}/viewaddress. The gathered value is processed with{{=response.views}}expression. Field components:- An array.
-
Uses template:
ViewT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/space.
The result is extracted from:{{=response.spaces}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/spaces/get-spaces.
- [Read single] action
-
Endpoint URL address:
/space/{{=parameters.space_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- space_id: Required. Please specify the space identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/spaces/get-space.
- [Create] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/space.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/spaces/create-space.
- [Update] action
-
Endpoint URL address:
/space/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/spaces/update-space.
- [Delete] action
-
Endpoint URL address:
/space/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/spaces/delete-space.
The resource includes the fields from the generalSpaceT template.
- tags
The value is gathered from
/space/{{=item.id}}/tagaddress. The gathered value is processed with{{=response.tags}}expression. Field components:- An array.
-
Uses template:
tagT.
- views
The value is gathered from
/space/{{=item.id}}/viewaddress. The gathered value is processed with{{=response.views}}expression. Field components:- An array.
-
Uses template:
ViewT.
Based on resource template Base.
- [Read space] action
-
Endpoint URL address:
/space/{{=parameters.space_id}}/tag.
The result is extracted from:{{=response.tags}}.The action has the following user-defined parameters:
- space_id: Required. Please specify the space identifier.
Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/tags/get-space-tags.html.
- [Read task] action
-
Endpoint URL address:
/task/{{=parameters.task_id}}.
The result is extracted from:{{=response.tags}}.
The result is paginated.The action has the following user-defined parameters:
- task_id: Required. Please specify the task identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/tasks/get-task.
- [Read time_entry] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/tags.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-20/get-all-tags-from-time-entries.
- [Create] action
-
Endpoint URL address:
/{{=item.parent.type}}/{{=item.parent.id}}/tag/{{=item.name}}.
- [Update] action
-
Endpoint URL address:
/{{=item.parent.type}}/{{=item.parent.id}}/tag/{{=item.name}}.The following request parameters will be automatically processed:
-
application/json:
{{={ tag : item } }}
Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/tags/edit-space-tag.html .
-
application/json:
- [Delete] action
-
Endpoint URL address:
/{{=item.parent.type}}/{{=item.parent.id}}/tag/{{=item.name}}.Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/tags/delete-space-tag.html https://clickup20.docs.apiary.io/#reference/0/tags/remove-tag-from-task .
The resource includes the fields from the tagT template.
- parent
Template: ParentT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/list/{{=parameters.list_id}}/task.
The result is extracted from:{{=response.tasks}}.The action has the following user-defined parameters:
- list_id: Required. Please specify the list identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/tasks/get-tasks.
- [Read single] action
-
Endpoint URL address:
/task/{{=parameters.task_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- task_id: Required. Please specify the task identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/tasks/get-task.
- [Read workspace] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/task.
The result is extracted from:{{=response.tasks}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/tasks/get-filtered-team-tasks.html.
- [Read view] action
-
Endpoint URL address:
/view/{{=parameters.view_id}}/task.
The result is extracted from:{{=response.tasks}}.The action has the following user-defined parameters:
- view_id: Required. Please specify the view identifier.
Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/views/get-view-tasks.html.
- [Create] action
-
Endpoint URL address:
/list/{{=parameters.list_id}}/task.The action has the following user-defined parameters:
- list_id: Required. Please specify the list identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/tasks/create-task.
- [Update] action
-
Endpoint URL address:
/task/{{=item.id}}.The action has the following user-defined parameters:
- list_id: Required. Please specify the list identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/tasks/update-task.
- [Delete] action
-
Endpoint URL address:
/task/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/tasks/delete-task.
The resource includes the fields from the TaskT template.
- list
-
Template: generalListT. The value is gathered from
/list/{{=item.list.id}}address. The gathered value is processed with{{=response}}expression.Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/get-list.
- folder
-
Template: generalFolderT. The value is gathered from
/folder/{{=item.folder.id}}address. The gathered value is processed with{{=response}}expression.Documentation: https://clickup20.docs.apiary.io/#reference/0/folders/get-folder.
- space
-
Template: generalSpaceT. The value is gathered from
/space/{{=item.space.id}}address. The gathered value is processed with{{=response}}expression.Documentation: https://clickup20.docs.apiary.io/#reference/0/spaces/get-space.
- members
-
The value is gathered from
/task/{{=item.id}}/memberaddress. The gathered value is processed with{{=response.members}}expression. Field components:- An array.
-
Uses template:
memberT.
Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/get-list.
- time_in_status
The value is gathered from
/task/{{=item.id}}/time_in_statusaddress. Field components:-
Uses template:
statusT. - Contains the following components: current_status, status_history.
-
Uses template:
- comments
The value is gathered from
/task/{{=item.id}}/commentaddress. The gathered value is processed with{{=response.comments}}expression. Field components:- An array.
-
Uses template:
commentT.
- [External]
-
The external fields URL address:
{{=parameters.get('list_id') && '/list/' + parameters.list_id + '/field'}}. The external fields list is extracted from:{{=parameters.get('list_id') && response.fields}}.- custom.{{=external.name}}
Template: {{=ClickUp.getFieldTemplate(external.type)}}. Before setting, the value is processed with
{{=value && { id: field.external.id, value: result } }}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/taskTemplate.
The result is extracted from:{{=response.templates}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/task-templates/get-task-templates.
- name
Template: ShortText.
- id
A key field. Template: ShortText.
Based on resource template Base.
- [Read task] action
-
Endpoint URL address:
/task/{{=parameters.task_id}}/comment.
The result is extracted from:{{=response.comments}}.The action has the following user-defined parameters:
- task_id: Required. Please specify the task identiier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/comments/get-task-comments.
- [Read list] action
-
Endpoint URL address:
/list/{{=parameters.list_id}}/comment.
The result is extracted from:{{=response.comments}}.The action has the following user-defined parameters:
- list_id: Required. Please specify the list_id.
Documentation: https://clickup20.docs.apiary.io/#reference/0/comments/get-list-comments.
- [Read view] action
-
Endpoint URL address:
/view/{{=parameters.view_id}}/comment.
The result is extracted from:{{=response.comments}}.The action has the following user-defined parameters:
- view_id: Required. Please specify the view identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/comments/get-chat-view-comments.
- [Create] action
-
Endpoint URL address:
/{{=item.parent.type}}/{{=item.parent.id}}/comment.
- [Update] action
-
Endpoint URL address:
/comment/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/comments/update-comment.
- [Delete] action
-
Endpoint URL address:
/comment/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/comments/delete-comment.
The resource includes the fields from the commentT template.
- parent
Template: ParentT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/space/{{=parameters.space_id}}/folder.
The result is extracted from:{{=response.folders}}.The action has the following user-defined parameters:
- space_id: Required. Please specify the space identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/folders/get-folders.
- [Read single] action
-
Endpoint URL address:
/folder/{{=parameters.folder_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- folder_id: Required. Please specify the folder identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/folders/get-folder.
- [Create] action
-
Endpoint URL address:
/space/{{=parameters.space_id}}/folder.The action has the following user-defined parameters:
- space_id: Required. Please specify the space identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/folders/create-folder.
- [Update] action
-
Endpoint URL address:
/folder/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/folders/update-folder.
- [Delete] action
-
Endpoint URL address:
/folder/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/folders/delete-folder.
The resource includes the fields from the generalFolderT template.
- space
Template: generalSpaceT. The value is gathered from
/space/{{=item.space.id}}address. The gathered value is processed with{{=response}}expression.- views
The value is gathered from
/folder/{{=item.id}}/viewaddress. The gathered value is processed with{{=response.views}}expression. Field components:- An array.
-
Uses template:
ViewT.
Based on resource template Base.
- [Read folder] action
-
Endpoint URL address:
/folder/{{=parameters.folder_id}}/list.
The result is extracted from:{{=response.lists}}.The action has the following user-defined parameters:
- folder_id: Required. Please specify the folder identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/get-lists.
- [Read single] action
-
Endpoint URL address:
/list/{{=parameters.list_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- list_id: Required. Please specify the list identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/get-list.
- [Read space] action
-
Endpoint URL address:
/space/{{=parameters.space_id}}/list.
The result is extracted from:{{=response.lists}}.The action has the following user-defined parameters:
- space_id: Required. Please specify the space identifier.
Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/lists/get-folderless-lists.html.
- [Create] action
-
Endpoint URL address:
/item.parent.type/{{=item.parent.id}}/list.Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/create-list.
- [Update] action
-
Endpoint URL address:
/list/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/update-list.
- [Delete] action
-
Endpoint URL address:
/list/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/delete-list.
The resource includes the fields from the generalListT template.
- parent
Template: ParentT.
- folder
Template: generalFolderT. The value is gathered from
/folder/{{=item.folder.id}}address. The gathered value is processed with{{=response}}expression.- space
Template: generalSpaceT. The value is gathered from
/space/{{=item.space.id}}address. The gathered value is processed with{{=response}}expression.- members
-
The value is gathered from
/list/{{=item.id}}/memberaddress. The gathered value is processed with{{=response.members}}expression. Field components:- An array.
-
Uses template:
memberT.
Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/get-list.
- views
The value is gathered from
/list/{{=item.id}}/viewaddress. The gathered value is processed with{{=response.views}}expression. Field components:- An array.
-
Uses template:
ViewT.
- tasks
The gathered value is processed with
{{=connection.resourceManager['Task'].getData({ parameters: ['list_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
TaskT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/group.
The result is extracted from:{{=response.groups}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/teams-user-groups/get-teams.
- [Create] action
-
Endpoint URL address:
/team/{{=item.team_id}}/group.Documentation: https://clickup20.docs.apiary.io/#reference/0/teams-user-groups/create-team.
- [Update] action
-
Endpoint URL address:
/group/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/teams-user-groups/update-team.
- [Delete] action
-
Endpoint URL address:
/group/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/teams-user-groups/delete-team.
- id
A key field. Template: ShortText.
- team_id
A key field. Template: ShortText.
- userid
Data type: DT_I4
- name
Template: ShortText.
- handle
Template: ShortText.
- date_created
Template: UnixTime. A read-only field.
- initials
Template: ShortText.
- members
Field components:
- An array.
-
Uses template:
memberT. - Contains the following components: add, rem.
- avatar
Field components:
-
Uses template:
ShortText. - Contains the following components: attachment_id, color, source, icon.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/customroles.
The result is extracted from:{{=response.custom_roles}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/roles/get-custom-roles.
- id
A key field. Data type: DT_I4
- team_id
Template: ShortText.
- name
Template: ShortText.
- inherited_role
Data type: DT_I4
- date_created
Template: UnixTime. A read-only field.
- members
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/goal.
The result is extracted from:{{=response.goals}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/goals/get-goals.
- [Read single] action
-
Endpoint URL address:
/goal/{{=parameters.goal_id}}.
The result is extracted from:{{=[response.goal]}}.
The result is paginated.The action has the following user-defined parameters:
- goal_id: Required. Please specify the goal identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/goals/get-goal.
- [Create] action
-
Endpoint URL address:
/team/{{=item.team_id}}/goal.Documentation: https://clickup20.docs.apiary.io/#reference/0/goals/create-goal.
- [Update] action
-
Endpoint URL address:
/goal/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/goals/update-goal.
- [Delete] action
-
Endpoint URL address:
/goal/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/goals/delete-goal.
- id
A key field. Template: ShortText.
- pretty_id
Template: ShortText.
- name
Template: ShortText.
- team_id
Template: ShortText.
- creator
Data type: DT_I4
- owner
Template: ShortText.
- color
Template: ShortText.
- date_created
Template: UnixTime. A read-only field.
- start_date
Template: UnixTime.
- due_date
Template: UnixTime.
- description
Template: ShortText.
- private
Data type: DT_BOOL
- archived
Data type: DT_BOOL
- multiple_owners
Data type: DT_BOOL
- editor_token
Template: ShortText.
- rem_owners
Template: LongText. A composite field.
- add_owners
Template: LongText. A composite field.
- date_updated
Template: UnixTime. A read-only field.
- last_update
Template: UnixTime.
- folder_id
Template: ShortText.
- history
Field components:
- An array.
-
Uses template:
GoalHistoryT.
- pinned
Data type: DT_BOOL
- owners
Field components:
- An array.
-
Uses template:
UserT.
- key_result_count
Data type: DT_I4
- members
Field components:
- An array.
-
Uses template:
memberT.
- group_members
Template: LongText. A composite field.
- percent_completed
Data type: DT_I4
- key_results
The value is gathered from
/goal/{{=item.id}}address. The gathered value is processed with{{=response.goal.key_results}}expression. Field components:- An array.
-
Uses template:
KeyResultT.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/task/{{=item.task_id}}/checklist.Documentation: https://clickup20.docs.apiary.io/#reference/0/checklists/create-checklist.
- [Update] action
-
Endpoint URL address:
/checklist/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/checklists/edit-checklist.
- [Delete] action
-
Endpoint URL address:
/checklist/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/checklists/delete-checklist.
- id
A key field. Template: ShortText.
- task_id
Template: ShortText.
- name
Template: ShortText.
- date_created
Template: UnixTime. A read-only field.
- orderindex
Data type: DT_I4
- creator
Data type: DT_I4
- resolved
Data type: DT_I4
- unresolved
Data type: DT_I4
- position
Data type: DT_I4
- items
Template: itemsT.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/checklist/{{=item.parent.id}}/checklist_item.The action has the following user-defined parameters:
- checklist_id: Required. Please specify the checklist identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/checklists/create-checklist-item.
- [Update] action
-
Endpoint URL address:
/checklist/{{=item.parent.id}}/checklist_item/{{=item.id}}.Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/checklists/edit-checklist-item.html.
- [Delete] action
-
Endpoint URL address:
/checklist/{{=item.parent.id}}/checklist_item/{{=item.id}}.Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/checklists/delete-checklist-item.html.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- orderindex
Template: ShortText.
- assignee
Template: UserT.
- resolved
Data type: DT_BOOL
- parent
Template: ParentT.
Based on resource template Base.
- [Read workspace] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/view.
The result is extracted from:{{=response.views}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/views/get-team-views.html.
- [Read space] action
-
Endpoint URL address:
/space/{{=parameters.space_id}}/view.
The result is extracted from:{{=response.views}}.The action has the following user-defined parameters:
- space_id: Required. Please specify the space identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/views/get-space-views.
- [Read folder] action
-
Endpoint URL address:
/folder/{{=parameters.folder_id}}/view.
The result is extracted from:{{=response.views}}.The action has the following user-defined parameters:
- folder_id: Required. Please specify the folder identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/views/get-folder-views.
- [Read] action
-
Endpoint URL address:
/list/{{=parameters.list_id}}/view.
The result is extracted from:{{=response.views}}.The action has the following user-defined parameters:
- list_id: Required. Please specify the list identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/views/get-list-views.
- [Create] action
-
Endpoint URL address:
/{{=item.parent.type}}/{{=item.parent.id}}/view.
- [Update] action
-
Endpoint URL address:
/view/{{=item.id}}.Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/views/update-view.html.
- [Delete] action
-
Endpoint URL address:
/view/{{=item.id}}.Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/views/delete-view.html.
The resource includes the fields from the ViewT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/task/{{=parameters.task_id}}.
The result is extracted from:{{=response.dependencies}}.The action has the following user-defined parameters:
- task_id: Required. Please specify the task identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/tasks/get-task.
- [Create] action
-
Endpoint URL address:
/task/{{=item.task_id}}/dependency.Documentation: https://clickup20.docs.apiary.io/#reference/0/dependencies/add-dependency.
- [Delete] action
-
Endpoint URL address:
/task/{{=item.task_id}}/dependency.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://clickup20.docs.apiary.io/#reference/0/dependencies/delete-dependency.
-
application/json:
The resource includes the fields from the DependencyT template.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/task/{{=item.task_id}}/link/{{=item.links_to}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/dependencies/add-task-link.
- [Delete] action
-
Endpoint URL address:
/task/{{=item.task_id}}/link/{{=item.links_to}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/dependencies/delete-task-link.
- task_id
A key field. Template: ShortText.
- links_to
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/goal/{{=parameters.goal_id}}.
The result is extracted from:{{=response.goal.key_results}}.
The result is paginated.The action has the following user-defined parameters:
- goal_id: Required. Please specify the goal identifier.
Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/goals/get-goal.html.
- [Create] action
-
Endpoint URL address:
/goal/{{=item.goal_id}}/key_result.Documentation: https://clickup20.docs.apiary.io/#reference/0/goals/create-key-result.
- [Update] action
-
Endpoint URL address:
/key_result/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/goals/edit-key-result.
- [Delete] action
-
Endpoint URL address:
/key_result/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/goals/delete-key-result.
The resource includes the fields from the KeyResultT template.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/list/{{=item.list_id}}/task/{{=item.task_id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/add-task-to-list.
- [Delete] action
-
Endpoint URL address:
/list/{{=item.list_id}}/task/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/lists/remove-task-from-list.
- list_id
A key field. Template: ShortText.
- task_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
- start_date: Required. Please specify the start date/time.
- end_date: Required. Please specify the start date/time.
The following request parameters will be automatically processed:
-
start_date:
{{=new Date(parameters.start_date).valueOf()}} -
end_date:
{{=new Date(parameters.end_date).valueOf()}}
Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/time-tracking-20/get-time-entries-within-a-date-range.html.
- [Read running] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/current.
The result is extracted from:{{=[response.data]}}.
The result is paginated.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-20/get-running-time-entry.
- [Read single] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/{{=parameters.timer_id}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
- timer_id: Required. Please specify the timer identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-20/get-singular-time-entry.
- [Create] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-2.0/create-a-time-entry.
- [Update] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/{{=item.id}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-20/update-a-time-entry.
- [Delete] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/{{=item.id}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-20/delete-a-time-entry.
- id
A key field. Template: ShortText.
- task
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, status, custom_type.
-
Uses template:
- wid
Template: ShortText.
- user
Template: UserT.
- billable
Data type: DT_BOOL
- start
Template: UnixTime.
- end
Template: UnixTime.
- duration
Template: ShortText.
- description
Template: ShortText.
- tags
Field components:
- An array.
-
Uses template:
tagT.
- task_tags
Field components:
- An array.
-
Uses template:
tagT.
- source
Template: ShortText.
- at
Template: UnixTime.
- task_location
Field components:
-
Uses template:
ShortText. - Contains the following components: list_id, folder_id, space_id, list_name, folder_name, space_name.
-
Uses template:
- task_url
Template: ShortText.
- history
The value is gathered from
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/{{=item.id}}/historyaddress. The gathered value is processed with{{=response.data)}}expression. Field components:- An array.
- Contains the following components: id, field, before, after, date, user_id, task_id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/tags.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-20/get-all-tags-from-time-entries.
- [Create] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/tags.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ time_entry_ids: _.pluck(batch, 'timer_id'), tags: batch } }}
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-20/add-tags-from-time-entries.
- [Update] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/tags.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-20/update-a-time-entry.
- [Delete] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/time_entries/{{=item.id}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ time_entry_ids: _.pluck(batch, 'timer_id'), tags: batch } }}
Documentation: https://clickup20.docs.apiary.io/#reference/0/time-tracking-20/delete-a-time-entry.
The resource includes the fields from the tagT template.
- timer_id
A key field. Template: ShortText.
- new_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/task/{{=parameters.task_id}}.
The result is extracted from:{{=response.attachments}}.
The result is paginated.The action has the following user-defined parameters:
- task_id: Required. Please specify the task identifier.
Documentation: https://jsapi.apiary.io/apis/clickup20/reference/0/tasks/get-task.html.
- [Create] action
-
Endpoint URL address:
/task/{{=parameters.task_id}}/attachment.The action has the following user-defined parameters:
- task_id: Required. Please specify the task_id.
The following request parameters will be automatically processed:
-
item:
{{=item.content}}
Documentation: https://clickup20.docs.apiary.io/#reference/0/attachments/create-task-attachment.
The resource includes the fields from the AttachmentT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}.
The result is extracted from:{{=response.team.members}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
- [Read single] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/user/{{=parameters.user_id}}.
The result is extracted from:{{=[response.member]}}.
The result is paginated.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
- user_id: Required. Please specify the user identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/users/get-user.
- [Create] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/user.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/users/invite-user-to-workspace.
- [Update] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/user/{{=item.id}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/users/edit-user-on-workspace.
- [Delete] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/user/{{=item.id}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/users/remove-user-from-workspace.
- id
A key field. Data type: DT_I4
- admin
Data type: DT_BOOL
Template: ShortText.
- username
Template: ShortText.
- custom_role_id
Data type: DT_I4
- user
Template: UserT.
- invited_by
Template: UserT. A read-only field.
- shared
Field components:
-
Uses template:
LongText. - Contains the following components: tasks, lists, folders.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/webhook.
The result is extracted from:{{=response.webhooks}}.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/webhooks/get-webhooks.
- [Create] action
-
Endpoint URL address:
/team/{{=ClickUp.UI.WorkspaceEditor.getValue(parameters)}}/webhook.The action has the following user-defined parameters:
- workspace_id: Required. Please specify the workspace identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/webhooks/create-webhook.
- [Update] action
-
Endpoint URL address:
/webhook/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/webhooks/update-webhook.
- [Delete] action
-
Endpoint URL address:
/webhook/{{=item.id}}.Documentation: https://clickup20.docs.apiary.io/#reference/0/webhooks/delete-webhook.
- id
A key field. Template: ShortText.
- userid
Data type: DT_I4
- team_id
Data type: DT_I4
- endpoint
Template: ShortText.
- client_id
Template: ShortText.
- events
Template: LongText. A composite field.
- task_id
Template: ShortText.
- list_id
Template: ShortText.
- folder_id
Template: ShortText.
- space_id
Template: ShortText.
- health
Field components:
-
Uses template:
ShortText. - Contains the following components: status, fail_count.
-
Uses template:
- secret
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/list/{{=parameters.list_id}}/field.
The result is extracted from:{{=response.fields}}.The action has the following user-defined parameters:
- list_id: Required. Please specify the list identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/custom-fields/get-accessible-custom-fields.
- [Update] action
-
Endpoint URL address:
/task/{{=parameters.task_id}}/field/{{=item.id}}.
The action uses POST method.The action has the following user-defined parameters:
- task_id: Required. Please specify the task identifier.
Documentation: https://clickup20.docs.apiary.io/#reference/0/custom-fields/set-custom-field-value.
- [Delete] action
-
Endpoint URL address:
/task/{{=parameters.task_id}}/field/{{=item.id}}.The action has the following user-defined parameters:
- task_id: Required. Please specify the task_id.
Documentation: https://clickup20.docs.apiary.io/#reference/0/custom-fields/remove-custom-field-value.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- type_config
Field components:
-
Uses template:
ShortText. - Contains the following components: default, precision, currency_type, placeholder, tracking, complete_on, options.
-
Uses template:
- date_created
Template: UnixTime. A read-only field.
- hide_from_guests
Data type: DT_BOOL
- value
Template: ShortText.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
page:
{{=parameters.iterator}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Bool
Data type: DT_BOOL
- Currency
Data type: DT_R8
- Number
Data type: DT_R8
- Content
Data type: DT_IMAGE
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(parseFloat(value)).toUTCString()}}expression. Before setting, the value is processed with{{=value && new Date(value).valueOf()}}expression.- UserT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, username, email, color, initials, profilePicture, role, custom_role, last_active, date_joined, date_invited.
-
Uses template:
- LocationT
Field components:
-
Uses template:
ShortText. - Contains the following components: location, place_id, formatted_address.
-
Uses template:
- ManualProgressT
Field components:
-
Uses template:
ShortText. - Contains the following components: current, percent_completed.
-
Uses template:
- AutomaticProgressT
Field components:
- Contains the following components: percent_complete.
- AttachmentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, date, title, type, source, version, extension, thumbnail_small, thumbnail_medium, thumbnail_large, is_folder, mimetype, hidden, parent_id, size, total_comments, resolved_comments, user, deleted, orientation, url, email_data, url_w_query, url_w_host, content.
-
Uses template:
- AttachmentsT
Field components:
- An array.
-
Uses template:
AttachmentT.
- ParentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, type.
-
Uses template:
- priorityT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, priority, color, orderindex.
-
Uses template:
- statusT
Field components:
-
Uses template:
ShortText. - Contains the following components: status, orderindex, color, type.
-
Uses template:
- statusesT
Field components:
- An array.
-
Uses template:
statusT.
- itemsT
Field components:
- An array.
- Contains the following components: id, name, orderindex, assignee, group_assignee, resolved, parent, date_created, children.
- checklistsT
Field components:
- An array.
- Contains the following components: id, task_id, name, date_created, orderindex, creator, resolved, unresolved, items.
- tagT
Field components:
-
Uses template:
ShortText. - Contains the following components: name, creator, tag_fg, tag_bg.
-
Uses template:
- commentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, comment, comment_text, user, resolved, notify_all, assignee, assignee_id, assigned_by, reactions, date.
-
Uses template:
- ViewT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, type, parent, grouping, divide, sorting, filters, columns, team_sidebar, settings.
-
Uses template:
- generalListT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, orderindex, content, status, priority, assignee, task_count, due_date, start_date, archived, override_statuses, permission_level.
-
Uses template:
- memberT
Template: UserT. Field components:
-
Uses template:
ShortText. - Contains the following components: isCreator, permission_level, profileInfo.
-
Uses template:
- generalFolderT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, hidden, access, orderindex, override_statuses, hidden, space, task_count, archived, statuses, lists, permission_level.
-
Uses template:
- generalSpaceT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, color, private, hidden, access, avatar, admin_can_manage, statuses, multiple_assignees, features, archived.
-
Uses template:
- TotalTimeT
Field components:
-
Uses template:
UnixTime. - Contains the following components: by_minute, since.
-
Uses template:
- GoalHistoryT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, key_result_id, userid, note, date_modified, steps_before, steps_taken, steps_current, workspace_id.
-
Uses template:
- KeyResultT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, note, type, unit, steps_start, steps_end, task_ids, list_ids, subcategory_ids, owners, goal_id, creator, date_created, goal_pretty_id, percent_completed, completed, owner, steps_current, workspace_id, last_action.
-
Uses template:
- DependencyT
Field components:
-
Uses template:
ShortText. - Contains the following components: depends_on, dependency_of, task_id, type, date_created, userid, workspace_id.
-
Uses template:
- TaskT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, custom_id, name, text_content, description, status, orderindex, date_created, date_updated, date_closed, archived, creator, assignees, watchers, checklists, tags, parent, priority, due_date, start_date, points, time_estimate, time_spent, dependencies, linked_tasks, team_id, url, permission_level, project, attachments, custom_fields.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.