Clickup

Clickup logo

Clickup

Configuration

ClickUp source connector integrates with the ClickUp API to extract and synchronize data.

Connects to your ClickUp workspaces.

It supports syncing workspaces, spaces, folders, lists, tasks, and comments.

Authentication

This connector uses OAuth 2.0 authentication. You can connect through the Airweave UI or API using the OAuth flow.

Supported authentication methods:

  • OAuth Browser Flow (recommended for UI)
  • OAuth Token (for programmatic access)
  • Auth Provider (enterprise SSO)

Configuration Options

This connector does not have any additional configuration options.

Data Models

The following data models are available for this connector:

Schema for ClickUp workspace entities.

FieldTypeDescription
workspace_idstrWorkspace ID
namestrWorkspace name
colorOptional[str]Workspace color
avatarOptional[str]Workspace avatar URL
membersList[Dict[str, Any]]List of workspace members

Schema for ClickUp space entities.

FieldTypeDescription
space_idstrSpace ID
namestrSpace name
privateboolWhether the space is private
statusDict[str, Any]Space status configuration
multiple_assigneesboolWhether multiple assignees are allowed
featuresDict[str, Any]Space features configuration

Schema for ClickUp folder entities.

FieldTypeDescription
folder_idstrFolder ID
namestrFolder name
hiddenboolWhether the folder is hidden
space_idstrParent space ID
task_countOptional[int]Number of tasks in the folder

Schema for ClickUp list entities.

FieldTypeDescription
list_idstrList ID
namestrList name
folder_idOptional[str]Parent folder ID (optional)
space_idstrParent space ID
contentOptional[str]List content/description
statusOptional[Dict[str, Any]]List status configuration
priorityOptional[Dict[str, Any]]List priority configuration
assigneeOptional[str]List assignee username
task_countOptional[int]Number of tasks in the list
due_dateOptional[Any]List due date
start_dateOptional[Any]List start date
folder_nameOptional[str]Parent folder name
space_namestrParent space name

Schema for ClickUp task entities.

FieldTypeDescription
task_idstrTask ID
namestrTask name
statusDict[str, Any]Task status configuration
priorityOptional[Dict[str, Any]]Task priority configuration
assigneesList[Dict[str, Any]]List of task assignees
tagsList[Dict[str, Any]]List of task tags
due_dateOptional[datetime]Task due date
start_dateOptional[datetime]Task start date
time_estimateOptional[int]Estimated time in milliseconds
time_spentOptional[int]Time spent in milliseconds
custom_fieldsList[Dict[str, Any]]List of custom fields
list_idstrParent list ID
folder_idstrParent folder ID
space_idstrParent space ID
urlstrTask URL
descriptionOptional[str]Task description
parentOptional[str]Parent task ID if this is a subtask

Schema for ClickUp comment entities.

FieldTypeDescription
comment_idstrComment ID
task_idstrParent task ID
userDict[str, Any]Comment author information
text_contentOptional[str]Comment text content
resolvedboolWhether the comment is resolved
assigneeOptional[Dict[str, Any]]Comment assignee information
assigned_byOptional[Dict[str, Any]]User who assigned the comment
reactionsList[Dict[str, Any]]List of reactions to the comment
dateOptional[datetime]Comment creation date

Schema for ClickUp subtask entities.

Supports nested subtasks where subtasks can have their own subtasks. The parent_task_id points to the immediate parent (task or subtask).

FieldTypeDescription
subtask_idstrSubtask ID
namestrSubtask name
parent_task_idstrImmediate parent task/subtask ID
statusDict[str, Any]Subtask status configuration
assigneesList[Dict[str, Any]]List of subtask assignees
due_dateOptional[datetime]Subtask due date
descriptionOptional[str]Subtask description
nesting_levelOptional[int]Nesting level (1 = direct subtask, 2 = nested subtask, etc.)

Schema for ClickUp file attachments.

Represents files attached to ClickUp tasks. Reference: https://api.clickup.com/api/v2/task/{task_id}

FieldTypeDescription
task_idstrID of the task this file is attached to
task_namestrName of the task this file is attached to
attachment_idstrClickUp attachment ID
versionOptional[int]Version number of the attachment
dateOptional[datetime]Date when the attachment was added
titleOptional[str]Original title/name of the attachment
extensionOptional[str]File extension
hiddenboolWhether the attachment is hidden
parentOptional[str]Parent attachment ID if applicable
thumbnail_smallOptional[str]URL for small thumbnail
thumbnail_mediumOptional[str]URL for medium thumbnail
thumbnail_largeOptional[str]URL for large thumbnail
is_folderOptional[bool]Whether this is a folder attachment
mimetypeOptional[str]MIME type of the file
total_commentsOptional[int]Number of comments on this attachment
urlOptional[str]Direct URL to download the attachment
url_w_queryOptional[str]URL with query parameters
url_w_hostOptional[str]URL with host parameters
email_dataOptional[Dict[str, Any]]Email data if attachment is from email
userOptional[Dict[str, Any]]User who uploaded the attachment
resolvedOptional[bool]Whether the attachment is resolved
resolved_commentsOptional[int]Number of resolved comments
sourceOptional[int]Source type of the attachment (numeric)
attachment_typeOptional[int]Type of the attachment (numeric)
orientationOptional[str]Image orientation if applicable
parent_idOptional[str]Parent task ID
deletedOptional[bool]Whether the attachment is deleted
workspace_idOptional[str]Workspace ID