> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickUp

> 'Access tasks from ClickUp'

## 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](https://help.clickup.com/hc/en-us/articles/13856392825367-Intro-to-the-Hierarchy)

<img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/clickup/ClickUp_Hierarchy.gif?s=621d963eaec5e405f652b91263ed0ac0" alt="ClickUp workspace hierarchy illustrating spaces, folders, and lists" width="1920" height="1080" data-path="assets/admins/connectors/clickup/ClickUp_Hierarchy.gif" />

## Setting up

### Authorization

<Steps>
  <Step title="Log in to ClickUp">
    Log into ClickUp.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Generate API token">
    Under API Token, click **Generate**. A Personal API token will be generated and displayed!

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/clickup/ClickupToken.png?fit=max&auto=format&n=aj13v1mzLf028SWE&q=85&s=9535e818ae26e2c0c0bc94b1ff19d40c" alt="Clickup token generation" width="2858" height="2112" data-path="assets/admins/connectors/clickup/ClickupToken.png" />
  </Step>
</Steps>

<img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/clickup/ClickupToken.png?fit=max&auto=format&n=aj13v1mzLf028SWE&q=85&s=9535e818ae26e2c0c0bc94b1ff19d40c" alt="Clickup token generation" width="2858" height="2112" data-path="assets/admins/connectors/clickup/ClickupToken.png" />

### Indexing

<Steps>
  <Step title="Open ClickUp connector">
    Navigate to the Admin Panel and select the **ClickUp** Connector
  </Step>

  <Step title="Enter API token and Team ID">
    In **Step 1**, provide your **API Token** and the **Team ID** from above.

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/clickup/ClickupAuth.png?fit=max&auto=format&n=aj13v1mzLf028SWE&q=85&s=40342437b73bf111e132aeed5f4c3c82" alt="Clickup connector authentication" width="2388" height="880" data-path="assets/admins/connectors/clickup/ClickupAuth.png" />
  </Step>

  <Step title="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 -

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/clickup/ClickupListid.png?fit=max&auto=format&n=aj13v1mzLf028SWE&q=85&s=28b7394f6bbd7ba8be8f2faadebf652d" alt="Clickup list id" width="2858" height="2112" data-path="assets/admins/connectors/clickup/ClickupListid.png" />
  </Step>

  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Start indexing">
    Click `Connect` to begin indexing.
  </Step>
</Steps>