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

# ClickUp

> Connect ClickUp to Omni for unified search across tasks and documents

The ClickUp connector enables Omni to index and search content from your ClickUp workspaces, including tasks, comments, and documents.

## Overview

### What Gets Indexed

| Source | Content                                                                 |
| ------ | ----------------------------------------------------------------------- |
| Tasks  | Task title, description, status, priority, assignee, tags, and comments |
| Docs   | Document title and content (optional — can be toggled on/off)           |

### How It Works

1. You create a ClickUp personal API token
2. The connector syncs tasks across all workspaces
3. Optionally enable document syncing
4. Workspace and space-based permissions ensure appropriate access control

<Note>
  The connector uses read-only access. Omni cannot create, modify, or delete any content in your ClickUp workspace.
</Note>

## Prerequisites

Before setting up the ClickUp connector, ensure you have:

* **ClickUp account** with permission to create API tokens
* **Omni deployment** with the ClickUp connector service running

## Setup

### Step 1: Create a ClickUp API Token

1. Go to [ClickUp Settings > Apps](https://app.clickup.com/settings/apps)
2. Under **API Token**, click **Generate**
3. Copy the generated token

<Warning>
  Keep your API token secure. Anyone with access to this token can read tasks and documents from your ClickUp workspace.
</Warning>

### Step 2: Connect in Omni

1. Navigate to **Settings** → **Integrations** in Omni
2. Find **ClickUp** and click **Connect**
3. Enter your API token
4. Optionally enable **Include Docs** to sync ClickUp documents alongside tasks
5. Click **Connect**
6. Click **Sync** to start the initial sync

<Check>
  Your ClickUp connector is now configured. Initial indexing may take a while depending on the number of tasks and documents in your workspaces.
</Check>

## Managing the Integration

### Viewing Sync Status

Navigate to **Settings** → **Integrations** to view the sync status for each source directly on the list, including last sync time, number of indexed items, and any errors. Click **Settings** on a source for more details and sync history.

### Space Filters

By default, the connector indexes tasks and documents across all workspaces your API token can access. Use **space filters** in the source settings to limit task indexing to specific ClickUp spaces. ClickUp Docs are indexed with workspace-level permissions, so space filters do not limit their permissions.

### Sync Modes

The ClickUp connector supports two sync modes:

| Mode            | Description                                                             |
| --------------- | ----------------------------------------------------------------------- |
| **Full**        | Syncs all tasks and documents across workspaces (used for initial sync) |
| **Incremental** | Syncs only items modified since last sync (used for updates)            |

After the initial full sync, the connector automatically performs incremental syncs to capture new and updated tasks and documents. Sync checkpoints are persisted safely, so interrupted runs resume from where they left off.

### MCP OAuth (Remote Tools)

The ClickUp connector can also serve as an MCP bridge, exposing ClickUp as a set of Omni agent tools for reading and writing tasks and documents. This requires per-user OAuth authorization:

1. Navigate to **Settings** → **Integrations** → **ClickUp**
2. Under the **MCP OAuth** section, click **Connect**
3. You'll be guided through a ClickUp OAuth flow with PKCE — no admin-created OAuth app is needed
4. Once connected, Omni gains access to ClickUp actions scoped to your OAuth grant

MCP tools are layered on top of the existing REST-based sync — the search index remains driven by the API token sync, while MCP actions use the per-user OAuth token for live read/write operations.

## Troubleshooting

<AccordionGroup>
  <Accordion title="Tasks not appearing in search">
    Common causes:

    * Sync has not completed yet
    * Your account does not have access to the workspace containing the tasks

    **Solution**: Verify the sync has completed and check that your API token has access to the relevant workspaces.
  </Accordion>

  <Accordion title="API token validation failed">
    The token may be expired or revoked.

    **Solution**:

    1. Go to [ClickUp Settings > Apps](https://app.clickup.com/settings/apps)
    2. Regenerate your API token
    3. Delete the existing ClickUp source in Omni and reconnect it with the new token
  </Accordion>

  <Accordion title="Rate limiting errors">
    ClickUp has API rate limits. The connector handles these automatically with exponential backoff.

    **Solution**: Wait for the connector to retry. For large workspaces, initial sync may take longer due to rate limits.
  </Accordion>

  <Accordion title="Documents not being indexed">
    Document syncing is an optional feature that must be explicitly enabled.

    **Solution**: Ensure **Include Docs** is enabled during setup. You can update this setting in **Settings** → **Integrations** → **ClickUp**.
  </Accordion>
</AccordionGroup>

## Security Considerations

* **Read-only access**: The connector only reads tasks and documents
* **Workspace and space permissions**: Tasks retain private-space grouping when applicable; Docs use workspace-level permissions
* **Token security**: API tokens should be treated like passwords
* **Encrypted storage**: Credentials are encrypted at rest in Omni

## What's Next

<CardGroup cols={3}>
  <Card title="Search Your Data" icon="magnifying-glass" href="/user-guide/search">
    Learn how to search across ClickUp tasks and documents
  </Card>

  <Card title="Omni Agent" icon="robot" href="/user-guide/ai-assistant">
    Ask questions about your ClickUp tasks and projects
  </Card>

  <Card title="Add More Connectors" icon="plug" href="/connectors/overview">
    Connect additional data sources
  </Card>
</CardGroup>