ClickUp - Setup Guide
Overview
The ClickUp source syncs workspace hierarchy and task data from ClickUp into Daspire.
Prerequisites
- A ClickUp account with access to the workspaces, spaces, folders, lists, and tasks you want to sync.
- A ClickUp personal API token, unless your Daspire workspace uses a managed ClickUp OAuth credential.
Authentication
Use a ClickUp credential that can access the workspace data you want to sync. For personal API token setups, paste the token into the API Token field. For managed OAuth setups, Daspire stores the connected credential securely and passes it to the connector at runtime.
Configuration
| Field | Required | Notes |
|---|---|---|
| API Token | Yes | ClickUp personal API token or managed access token supplied by Daspire. |
| Workspace IDs | No | Limit the sync to specific ClickUp workspaces. Leave empty to read every workspace available to the credential. |
| Space IDs | No | Limit hierarchy traversal and workspace-endpoint task filters to specific spaces. |
| Folder IDs | No | Limit list discovery to specific folders. |
| List IDs | No | Limit task reads to specific lists. Behavior depends on the Task Fetch Strategy. |
| View IDs | No | Read tasks from specific ClickUp views. View IDs take priority over Task Fetch Strategy. |
| Assignee IDs | No | Limit task reads to specific ClickUp users. |
| Include Closed Tasks | No | Enable this when reporting on completed work or filtering by date_done. |
| Include Subtasks | No | Include subtasks in task results. |
| Include Archived Hierarchy | No | Include archived Spaces, Folders, and Lists during hierarchy traversal. |
| Include Folderless Lists | No | Include lists directly under Spaces, not only lists under Folders. |
| Task Fetch Strategy | No | Workspace endpoint reads tasks through ClickUp's workspace task endpoint and applies filters. List endpoint reads directly from selected or discovered lists. |
| Task Date Filter Field | No | Choose which task timestamp is filtered by Start Date and End Date. |
| Start Date | No | Inclusive lower bound for the selected task timestamp. Accepts ISO-8601 datetime, YYYY-MM-DD, or Unix milliseconds. |
| End Date | No | Exclusive upper bound for the selected task timestamp. Accepts ISO-8601 datetime, YYYY-MM-DD, or Unix milliseconds. |
Task Fetch Strategy
Use Workspace endpoint when you want cross-list task reporting with date, assignee, space, or list filters. This is the default and is usually the right choice for completion reports.
Use List endpoint when you need Daspire to read each ClickUp List directly. If List IDs are provided, Daspire reads those lists. If List IDs are empty, Daspire discovers lists by traversing the selected workspace hierarchy.
Supported Streams
| Stream | Description |
|---|---|
user | Authenticated ClickUp user metadata. |
team | ClickUp workspaces available to the credential. |
groups | Workspace groups. |
spaces | Spaces under selected workspaces. |
folders | Folders under selected spaces. |
lists | Lists under selected folders and, when enabled, lists directly under spaces. |
tasks | ClickUp tasks. |
task_assignees | Flattened task-to-assignee records. |
Troubleshooting
| Issue | Action |
|---|---|
| Missing workspace data | Confirm the credential can access the ClickUp workspace and re-check Workspace IDs. |
| Missing tasks from a list | Confirm List IDs are correct. If using Workspace endpoint, try List endpoint to read the list directly. |
| Completed tasks missing | Enable Include Closed Tasks, especially when filtering by date_done. |
| Empty date-filtered results | Re-check the Task Date Filter Field, Start Date, and End Date. End Date is exclusive. |