How it works

The ClickUp connector will pull in all tasks from the ClickUp workspace, or specific space(s), list(s), folder(s) specified by the user. Tasks are updated every 10 minutes.

Understanding ClickUp Hierarchy

In ClickUp, there are multiple containers which contain task(s). These could be -
  • Entire Workspace
  • Spaces
  • Folders
  • Lists
Detailed information on the hierarchy of above mentioned objects is available here ClickUp workspace hierarchy illustrating spaces, folders, and lists

Setting up

Authorization

1

Log in to ClickUp

Log into ClickUp.
2

Open Apps settings

In ClickUp 2.0, click your avatar in the lower-left corner and select Apps. In ClickUp 3.0, click your avatar in the upper-right corner, select Settings, and scroll down to click Apps in the sidebar.
3

Generate API token

Under API Token, click Generate. A Personal API token will be generated and displayed!Clickup token generation
Clickup token generation

Indexing

1

Open ClickUp connector

Navigate to the Admin Panel and select the ClickUp Connector
2

Enter API token and Team ID

In Step 1, provide your API Token and the Team ID from above.Clickup connector authentication
3

Select connector type

Select the type of connector you want to pull in tasks from.Notes
  • This could be Entire Workspace, Space(s), List(s), or Folder(s).
  • To pull tasks from entire workspace, just select Entire Workspace from the dropdown, and do not add any ID(s).
  • To pull tasks from specific space(s), folder(s), or lists(s), select the respective option from the dropdown, and add the ID(s) below. At least one ID needs to be added in this case.
  • The space id(s), folder id(s), list id(s) could be found in the web url in Clickup. For example, if you open a list in the ClickUp UI, you will see the list id in the url address bar as follows -
Clickup list id
4

Enter IDs as needed

If any of the Space(s), List(s), or Folder(s) connector type is selected, add one or more respective IDs to index the tasks from.
5

Choose comment indexing

Check Retrieve Task Comments? to also retrieve and index all comments for each indexed task. Leave this unchecked if you don’t want to index task comments.
6

Start indexing

Click Connect to begin indexing.