> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.airweave.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.airweave.ai/_mcp/server.
# Clickup
> Clickup integration with Airweave
{/* AUTO-GENERATED CONTENT START */}
Clickup
This connector enables AI agents and RAG systems to retrieve context from Clickup through Airweave's unified search layer.
## 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.
#### [View Source Code](https://github.com/airweave-ai/airweave/tree/main/backend/airweave/platform/sources/clickup.py)
Explore the Clickup connector implementation
### 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:
#### ClickUpWorkspaceEntity
Schema for ClickUp workspace entities.
| Field | Type | Description |
| ------------- | ---------------------- | ------------------------- |
| workspace\_id | str | Workspace ID |
| name | str | Workspace name |
| color | Optional\[str] | Workspace color |
| avatar | Optional\[str] | Workspace avatar URL |
| members | List\[Dict\[str, Any]] | List of workspace members |
#### ClickUpSpaceEntity
Schema for ClickUp space entities.
| Field | Type | Description |
| ------------------- | --------------- | -------------------------------------- |
| space\_id | str | Space ID |
| name | str | Space name |
| workspace\_id | str | Parent workspace ID |
| private | bool | Whether the space is private |
| status | Dict\[str, Any] | Space status configuration |
| multiple\_assignees | bool | Whether multiple assignees are allowed |
| features | Dict\[str, Any] | Space features configuration |
#### ClickUpFolderEntity
Schema for ClickUp folder entities.
| Field | Type | Description |
| ------------- | -------------- | ----------------------------- |
| folder\_id | str | Folder ID |
| name | str | Folder name |
| workspace\_id | str | Parent workspace ID |
| space\_id | str | Parent space ID |
| hidden | bool | Whether the folder is hidden |
| task\_count | Optional\[int] | Number of tasks in the folder |
#### ClickUpListEntity
Schema for ClickUp list entities.
| Field | Type | Description |
| ------------- | -------------------------- | --------------------------- |
| list\_id | str | List ID |
| name | str | List name |
| workspace\_id | str | Parent workspace ID |
| space\_id | str | Parent space ID |
| folder\_id | Optional\[str] | Parent folder ID (optional) |
| content | Optional\[str] | List content/description |
| status | Optional\[Dict\[str, Any]] | List status configuration |
| priority | Optional\[Dict\[str, Any]] | List priority configuration |
| assignee | Optional\[str] | List assignee username |
| task\_count | Optional\[int] | Number of tasks in the list |
| due\_date | Optional\[Any] | List due date |
| start\_date | Optional\[Any] | List start date |
| folder\_name | Optional\[str] | Parent folder name |
| space\_name | str | Parent space name |
#### ClickUpTaskEntity
Schema for ClickUp task entities.
| Field | Type | Description |
| -------------- | -------------------------- | ----------------------------------- |
| task\_id | str | Task ID |
| name | str | Task name |
| created\_at | Optional\[Any] | Task creation timestamp |
| updated\_at | Optional\[Any] | Task update timestamp |
| status | Dict\[str, Any] | Task status configuration |
| priority | Optional\[Dict\[str, Any]] | Task priority configuration |
| assignees | List\[Dict\[str, Any]] | List of task assignees |
| tags | List\[Dict\[str, Any]] | List of task tags |
| due\_date | Optional\[Any] | Task due date |
| start\_date | Optional\[Any] | Task start date |
| time\_estimate | Optional\[int] | Estimated time in milliseconds |
| time\_spent | Optional\[int] | Time spent in milliseconds |
| custom\_fields | List\[Dict\[str, Any]] | List of custom fields |
| list\_id | str | Parent list ID |
| folder\_id | Optional\[str] | Parent folder ID |
| space\_id | str | Parent space ID |
| workspace\_id | str | Parent workspace ID |
| url | str | Task URL |
| description | Optional\[str] | Task description |
| parent | Optional\[str] | Parent task ID if this is a subtask |
#### ClickUpCommentEntity
Schema for ClickUp comment entities.
| Field | Type | Description |
| ------------- | -------------------------- | -------------------------------- |
| comment\_id | str | Comment ID |
| name | str | Comment preview |
| created\_at | Optional\[Any] | When the comment was created |
| task\_id | str | Parent task ID |
| user | Dict\[str, Any] | Comment author information |
| text\_content | Optional\[str] | Comment text content |
| resolved | bool | Whether the comment is resolved |
| assignee | Optional\[Dict\[str, Any]] | Comment assignee information |
| assigned\_by | Optional\[Dict\[str, Any]] | User who assigned the comment |
| reactions | List\[Dict\[str, Any]] | List of reactions to the comment |
#### ClickUpSubtaskEntity
Schema for ClickUp subtask entities.
| Field | Type | Description |
| ---------------- | ---------------------- | ------------------------------------------------------------ |
| subtask\_id | str | Subtask ID |
| name | str | Subtask name |
| created\_at | Optional\[Any] | Subtask creation timestamp |
| updated\_at | Optional\[Any] | Subtask update timestamp |
| parent\_task\_id | str | Immediate parent task/subtask ID |
| status | Dict\[str, Any] | Subtask status configuration |
| assignees | List\[Dict\[str, Any]] | List of subtask assignees |
| due\_date | Optional\[Any] | Subtask due date |
| description | Optional\[str] | Subtask description |
| nesting\_level | Optional\[int] | Nesting level (1 = direct subtask, 2 = nested subtask, etc.) |
| url | Optional\[str] | Subtask URL |
#### ClickUpFileEntity
Schema for ClickUp file attachments.
| Field | Type | Description |
| ------------------ | -------------------------- | ----------------------------------------- |
| attachment\_id | str | Attachment ID |
| name | str | Attachment name |
| task\_id | str | ID of the task this file is attached to |
| task\_name | str | Name of the task this file is attached to |
| version | Optional\[int] | Version number of the attachment |
| title | Optional\[str] | Original title/name of the attachment |
| extension | Optional\[str] | File extension |
| hidden | bool | Whether the attachment is hidden |
| parent | Optional\[str] | Parent attachment ID if applicable |
| thumbnail\_small | Optional\[str] | URL for small thumbnail |
| thumbnail\_medium | Optional\[str] | URL for medium thumbnail |
| thumbnail\_large | Optional\[str] | URL for large thumbnail |
| is\_folder | Optional\[bool] | Whether this is a folder attachment |
| total\_comments | Optional\[int] | Number of comments on this attachment |
| url\_w\_query | Optional\[str] | URL with query parameters |
| url\_w\_host | Optional\[str] | URL with host parameters |
| email\_data | Optional\[Dict\[str, Any]] | Email data if attachment is from email |
| user | Optional\[Dict\[str, Any]] | User who uploaded the attachment |
| resolved | Optional\[bool] | Whether the attachment is resolved |
| resolved\_comments | Optional\[int] | Number of resolved comments |
| source | Optional\[int] | Source type of the attachment (numeric) |
| attachment\_type | Optional\[int] | Type of the attachment (numeric) |
| orientation | Optional\[str] | Image orientation if applicable |
| parent\_id | Optional\[str] | Parent task ID |
| deleted | Optional\[bool] | Whether the attachment is deleted |
| workspace\_id | Optional\[str] | Workspace ID |
{/* AUTO-GENERATED CONTENT END */}