Skip to main content

ClickUp API

Sync overview

This source can sync data from ClickUp API. Currently, this connector only supports full refresh syncs. That is, every time a sync is run, all the records are fetched from the source.

Output schema

This source is capable of syncing the following streams:

Features

FeatureSupported? (Yes/No)Notes
Full Refresh SyncYes
Incremental SyncNo

Performance considerations

The ClickUp API enforces request rate limits per token. The rate limits are depending on your workplace plan. See here.

Getting started

Requirements

  1. Generate an API key from ClickUp. See here.

Setup guide

The following fields are required fields for the connector to work:

  • api_token: Your ClickUp API Token.

Here are some optional fields for different streams:

  • team_id: Your team ID in your ClickUp workspace. It is required for space stream.

  • space_id: Your space ID in your ClickUp workspace. It is required for folder stream.

  • folder_id: Your folder ID in your ClickUp space. It is required for list stream.

  • list_id: Your list ID in your folder of space. It is required for task stream.

  • Include Closed Tasks: Toggle to include or exclude closed tasks. By default, they are excluded.

Reference

Config fields reference

Field
Type
Property name
string
api_token
string
team_id
string
space_id
string
folder_id
string
list_id
boolean
include_closed_tasks

Changelog

Expand to review
VersionDatePull RequestSubject
0.1.32024-06-2240061Update dependencies
0.1.22024-05-2138501[autopull] base image + poetry + up_to_date
0.1.12023-02-1023951Add optional include Closed Tasks
0.1.02022-11-0717770New source