Agent Connector

Connect your agents to Clickup Api

Production-ready access to your Clickup Api data with managed auth, parametric control, and the reliability your agents need to actually work.

Try it freeTalk to sales

Installation & Usage

Get start with the Clickup Api connector in minutes.

[01]

Install Package

Using uv or pip

BASH

Copy
uv pip install airbyte-agent-clickup-api

[02]

Import

Initialize and use

PYTHON

Copy
from airbyte_agent_clickup_api import ClickupApiConnector
from airbyte_agent_clickup_api.models import ClickupApiAuthConfig

connector = ClickupApiConnector(
    auth_config=ClickupApiAuthConfig(
        api_key="<Your ClickUp personal API token>"
    )
)

[03]

Tool

Add tools to your agent

python

Copy
@agent.tool_plain # assumes you're using Pydantic AI
@ClickupApiConnector.tool_utils
async def clickup_api_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Supported Entities & Actions

Access all your Clickup Api data through a unified API

Lorem ipsum

Lorem ipsum

| Entity | Actions |\n|--------|---------|\n| User | [Get](./REFERENCE.md#user-get) |\n| Teams | [List](./REFERENCE.md#teams-list) |\n| Spaces | [List](./REFERENCE.md#spaces-list), [Get](./REFERENCE.md#spaces-get) |\n| Folders | [List](./REFERENCE.md#folders-list), [Get](./REFERENCE.md#folders-get) |\n| Lists | [List](./REFERENCE.md#lists-list), [Get](./REFERENCE.md#lists-get) |\n| Tasks | [List](./REFERENCE.md#tasks-list), [Get](./REFERENCE.md#tasks-get), [API Search](./REFERENCE.md#tasks-api_search) |\n| Comments | [List](./REFERENCE.md#comments-list), [Create](./REFERENCE.md#comments-create), [Get](./REFERENCE.md#comments-get), [Update](./REFERENCE.md#comments-update) |\n| Goals | [List](./REFERENCE.md#goals-list), [Get](./REFERENCE.md#goals-get) |\n| Views | [List](./REFERENCE.md#views-list), [Get](./REFERENCE.md#views-get) |\n| View Tasks | [List](./REFERENCE.md#view-tasks-list) |\n| Time Tracking | [List](./REFERENCE.md#time-tracking-list), [Get](./REFERENCE.md#time-tracking-get) |\n| Members | [List](./REFERENCE.md#members-list) |\n| Docs | [List](./REFERENCE.md#docs-list), [Get](./REFERENCE.md#docs-get) |

View full reference documentation

Example Prompts

The Clickup Api connector is optimized to handle prompts like these

Lorem ipsum

List all workspaces I have access to - Show me the spaces in my workspace - List the folders in a space - Show me the lists in a folder - Get the tasks in a list - Get details for a specific task - Search for tasks containing 'bug' across my workspace - Find all urgent priority tasks in my workspace - Show me tasks assigned to a specific user - List comments on a task - Get threaded replies on a comment - Create a comment on a task - Update a comment to mark it resolved - List all goals in my workspace - Get details for a specific goal - Show me all workspace-level views - Get tasks matching a saved view - List time entries for my workspace this week - Get details for a specific time entry - Show me the members assigned to a task - List all docs in my workspace - Get details for a specific doc - What tasks are overdue in my workspace? - Which tasks were updated in the last 24 hours? - Show me all high-priority tasks across all projects - How much time has been tracked this week? - What are the most commented tasks?

View full reference documentation

Why Airbyte for AI Agents?

Built for production AI workloads with enterprise-grade reliability

Secure Authentication

Built-in OAuth 2.0 handling with automatic token refresh. No hard-coded credentials.

Agent-Native Design
Heading

Structured, LLM-friendly schemas optimized for AI agent consumption with natural language query support.

Production Ready

Battle-tested connectors with comprehensive error handling, logging, and retry logic.

Open Source

Fully open source under the MIT license. Contribute, customize, and extend freely.

Explore more connectorsTalk to sales

Works with your favorite frameworks

Use the Salesforce connector with any AI agent framework.

LangChain

CrewAI

LlamaIndex

AutoGen

OpenAI Agents SDK

Claude Agents SDK

Frequently Asked Questions

Didn't find your answer? Please don't hesitate to reach out.

How do I authenticate with Clickup Api?

The clickup-api connector supports API key authentication using your ClickUp personal API token. In open source mode, you provide the token directly via the ClickupApiAuthConfig with an api_key field. In hosted mode, credentials are stored securely in Airbyte Cloud and accessed via Airbyte client credentials.

Can I use this connector with any AI agent framework?

The connector is compatible with any Python-based AI agent framework including LangChain, LlamaIndex, CrewAI, Pydantic AI, and custom implementations.

Does this connector support write operations?

The clickup-api connector supports some write operations. It can create comments on tasks and update existing comments. However, it does not currently support delete operations such as deleting tasks, comments, or goals.

How is this different from the Airbyte data connector?

Agent connectors are specifically designed for AI agents and LLM applications. They provide natural language interfaces, optimized response formats, and seamless integration with agent frameworks, unlike traditional ETL-focused connectors.

Ready to connect your AI agents to Clickup Api?

Get started in minutes with our open-source connector.

Go to github
READ THE DOCS