跳到主要内容

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 account that can authorize Daspire through ClickUp OAuth, or a personal API token for legacy internal setups.

Authentication

Use Daspire OAuth to connect a ClickUp account from the source setup form. Daspire stores the connected credential securely and injects the runtime access token for the connector.

The Personal API Token option remains available for legacy internal setups.

Configuration

FieldRequiredNotes
AuthenticationYesChoose Daspire OAuth or Personal API Token. OAuth is the preferred setup path.
Workspace IDsNoLimit the sync to specific ClickUp workspaces. Leave empty to read every workspace available to the credential.
Space IDsNoLimit hierarchy traversal and workspace-endpoint task filters to specific spaces.
Folder IDsNoLimit list discovery to specific folders.
List IDsNoLimit task reads to specific lists. Behavior depends on the Task Fetch Strategy.
View IDsNoRead tasks from specific ClickUp views. View IDs take priority over Task Fetch Strategy.
Assignee IDsNoLimit task reads to specific ClickUp users.
Include Closed TasksNoEnable this when reporting on completed work or filtering by date_done.
Include SubtasksNoInclude subtasks in task results.
Include Archived HierarchyNoInclude archived Spaces, Folders, and Lists during hierarchy traversal.
Include Folderless ListsNoInclude lists directly under Spaces, not only lists under Folders.
Task Fetch StrategyNoWorkspace endpoint reads tasks through ClickUp's workspace task endpoint and applies filters. List endpoint reads directly from selected or discovered lists.
Task Date Filter FieldNoChoose which task timestamp is filtered by Start Date and End Date.
Start DateNoInclusive lower bound for the selected task timestamp. Accepts ISO-8601 datetime, YYYY-MM-DD, or Unix milliseconds.
End DateNoExclusive 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

StreamDescription
userAuthenticated ClickUp user metadata.
teamClickUp workspaces available to the credential.
groupsWorkspace groups.
spacesSpaces under selected workspaces.
foldersFolders under selected spaces.
listsLists under selected folders and, when enabled, lists directly under spaces.
tasksClickUp tasks.
task_assigneesFlattened task-to-assignee records.

Troubleshooting

IssueAction
Missing workspace dataConfirm the credential can access the ClickUp workspace and re-check Workspace IDs.
Missing tasks from a listConfirm List IDs are correct. If using Workspace endpoint, try List endpoint to read the list directly.
Completed tasks missingEnable Include Closed Tasks, especially when filtering by date_done.
Empty date-filtered resultsRe-check the Task Date Filter Field, Start Date, and End Date. End Date is exclusive.