Adding the data source
Based on ClickUp API documentation
Requirements
Make sure to use an user with admin access to the Workspaces to be replicated
Instructions
Currently ClickUp has two versions: ClickUp 2.0 and ClickUp 3.0. Following you can find the instructions to obtain the API Key in both versions.
Instructions to ClickUp 2.0
1) Log in to your ClickUp account, click on your profile icon on the bottom left and then on "My Settings";
2) On the settings page, on the left bar, look for “Apps”;
3) Search for the “API Token” section and copy the value found – this is the time to generate a first API Token if you don’t have one yet;
5) Name your data source and, in API Token, paste the value obtained in step 3 and click "SAVE".
Instructions to ClickUp 3.0
1) Log in to your ClickUp account, click on your profile icon on the upper-right corner and then on "Settings";
2) Scroll down and click on the “Apps” section in the sidebar;
3) Search for the “API Token” section and click on “Generate” if you don't have an API token yet, or on “Regenerate” if you already have one. Copy the value displayed in the “API Token” section;
5) Name your data source and, in API Token, paste the value obtained in step 3 and click "SAVE".
Pipelines
Relationship Chart
Workspaces
| Field | Type | |
|---|---|---|
| id | text | |
| name | text | |
| color | text | |
| avatar | text |
Spaces
Main object
| Field | Type | |
|---|---|---|
| space_id | text | |
| workspace_id | text | |
| archived | boolean | |
| multiple_assignees | boolean | |
| name | text | |
| private | boolean |
priorities
| Field | Type | |
|---|---|---|
| space_id | text | |
| color | text | |
| priority_id | float | |
| priorities__orderindex | float | |
| priorities__priority | text |
statuses
| Field | Type | |
|---|---|---|
| space_id | text | |
| status_id | text | |
| color | text | |
| orderindex | float | |
| status | text | |
| type | text |
_features
| Field | Type | |
|---|---|---|
| space_id | text | |
| eature | text | |
| feature_key | text | |
| feature_val | boolean |
Folders
Main object
| Field | Type | |
|---|---|---|
| folder_id | text | |
| space_id | text | |
| archived | boolean | |
| hidden | boolean | |
| name | text | |
| orderindex | float | |
| override_statuses | boolean | |
| permission_level | text | |
| task_count | float |
statuses
| Field | Type | |
|---|---|---|
| folder_id | text | |
| color | text | |
| status_id | text | |
| orderindex | float | |
| status | text | |
| type | text |
Lists
| Field | Type | |
|---|---|---|
| list_id | text | |
| folder_id | text | |
| archived | boolean | |
| due_date | timestamp | |
| name | text | |
| orderindex | float | |
| override_statuses | boolean | |
| permission_level | text | |
| priority__color | text | |
| priority__priority | text | |
| start_date | timestamp | |
| status__color | text | |
| status__hide_label | boolean | |
| status__status | text | |
| task_count | float |
Lists members
| Field | Type | |
|---|---|---|
| list_id | text | |
| user_id | text | |
| username | text | |
| text | ||
| color | text | |
| initials | text | |
| profilepicture | text |
Tasks: custom fields
| Field | Type | |
|---|---|---|
| task_id | text | |
| field_x | text | |
| field_y | timestamp | |
| field_z | float |
Custom fields from tasks inside folderless lists will not be returned
Tasks: time in status
The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin
Main object
| Field | Type | |
|---|---|---|
| task_id | text | |
| current_status_name | text | |
| current_status_color | text | |
| current_status_total_time_by_minute | float | |
| current_status_total_time_since | timestamp |
status_history
| Field | Type | |
|---|---|---|
| task_id | text | |
| status_name | text | |
| status_color | text | |
| status_type | text | |
| total_time_by_minute | float | |
| total_time_since | timestamp | |
| orderindex | float |
Add ClickUp as a data source on Kondado
Connect your ClickUp workspace data to Kondado by generating an API token and configuring the source for your pipelines.
Verify admin access requirements
Ensure you are using a ClickUp user with admin access to the Workspaces you want to replicate, as this is required for successful data extraction.
Generate API token for your ClickUp version
For ClickUp 2.0, go to My Settings → Apps → API Token. For ClickUp 3.0, go to Settings → Apps → Generate/Regenerate API Token. Copy the token value shown.
Add ClickUp source on Kondado platform
On the Kondado platform, navigate to the add new sources page, select the ClickUp data source, name your connection, paste the API Token, and click SAVE to complete the setup.
Review available ClickUp entities and relationships
Familiarize yourself with the data integration schema including Workspaces, Spaces, Folders, Lists, Tasks, and their related sub-entities to plan your pipeline configuration effectively.
Enable required ClickApps before extraction
For Tasks time-in-status data, confirm the Workspace owner or admin has enabled the Total time in Status ClickApp in ClickUp, otherwise this data will not be returned.
Connect ClickUp data to your preferred destination
Once configured, send your ClickUp data to destinations such as BI tools, data warehouses, or spreadsheets for analysis and reporting.