Clickup-Api authentication
This page documents the authentication and configuration options for the Clickup-Api agent connector.
Authentication
Open source execution
In open source mode, you provide API credentials directly to the connector.
OAuth
This authentication method isn't available for this connector.
Token
credentials fields you need:
| Field Name | Type | Required | Description |
|---|---|---|---|
api_key | str | Yes | Your ClickUp personal API token |
Example request:
from airbyte_agent_sdk.connectors.clickup_api import ClickupApiConnector
from airbyte_agent_sdk.connectors.clickup_api.models import ClickupApiAuthConfig
connector = ClickupApiConnector(
auth_config=ClickupApiAuthConfig(
api_key="<Your ClickUp personal API token>"
)
)
Hosted execution
In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the hosted execution tutorial.
OAuth
This authentication method isn't available for this connector.
Bring your own OAuth flow
This authentication method isn't available for this connector.
Token
Create a connector with Token credentials.
credentials fields you need:
| Field Name | Type | Required | Description |
|---|---|---|---|
api_key | str | Yes | Your ClickUp personal API token |
Example request:
curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"workspace_name": "<WORKSPACE_NAME>",
"connector_type": "Clickup-Api",
"name": "My Clickup-Api Connector",
"credentials": {
"api_key": "<Your ClickUp personal API token>"
}
}'
Execution
After creating the connector, execute operations using either the Python SDK or API.
If your Airbyte client can access multiple organizations, include organization_id in AirbyteAuthConfig and X-Organization-Id in raw API calls.
Python SDK
The connect() factory returns a fully typed ClickupApiConnector and reads AIRBYTE_CLIENT_ID / AIRBYTE_CLIENT_SECRET from the environment:
- Pydantic AI
- LangChain
- FastMCP
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.clickup_api import ClickupApiConnector
connector = connect("clickup-api", workspace_name="<your_workspace_name>")
@agent.tool_plain
@ClickupApiConnector.tool_utils
async def clickup_api_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})
import json
from langchain_core.tools import tool
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.clickup_api import ClickupApiConnector
connector = connect("clickup-api", workspace_name="<your_workspace_name>")
@tool
@ClickupApiConnector.tool_utils
async def clickup_api_execute(entity: str, action: str, params: dict | None = None) -> str:
"""Execute Clickup-Api connector operations."""
result = await connector.execute(entity, action, params or {})
return json.dumps(result, default=str)
import json
from fastmcp import FastMCP
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.clickup_api import ClickupApiConnector
connector = connect("clickup-api", workspace_name="<your_workspace_name>")
mcp = FastMCP("Clickup-Api Agent")
@mcp.tool()
@ClickupApiConnector.tool_utils
async def clickup_api_execute(entity: str, action: str, params: dict | None = None) -> str:
"""Execute Clickup-Api connector operations."""
result = await connector.execute(entity, action, params or {})
return json.dumps(result, default=str)
Or pass credentials explicitly (equivalent, useful when you're not loading them from the environment): Pydantic AI
- Pydantic AI
- LangChain
- FastMCP
from airbyte_agent_sdk.connectors.clickup_api import ClickupApiConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig
connector = ClickupApiConnector(
auth_config=AirbyteAuthConfig(
workspace_name="<your_workspace_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
@agent.tool_plain
@ClickupApiConnector.tool_utils
async def clickup_api_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})
import json
from langchain_core.tools import tool
from airbyte_agent_sdk.connectors.clickup_api import ClickupApiConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig
connector = ClickupApiConnector(
auth_config=AirbyteAuthConfig(
workspace_name="<your_workspace_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
@tool
@ClickupApiConnector.tool_utils
async def clickup_api_execute(entity: str, action: str, params: dict | None = None) -> str:
"""Execute Clickup-Api connector operations."""
result = await connector.execute(entity, action, params or {})
return json.dumps(result, default=str)
import json
from fastmcp import FastMCP
from airbyte_agent_sdk.connectors.clickup_api import ClickupApiConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig
connector = ClickupApiConnector(
auth_config=AirbyteAuthConfig(
workspace_name="<your_workspace_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
mcp = FastMCP("Clickup-Api Agent")
@mcp.tool()
@ClickupApiConnector.tool_utils
async def clickup_api_execute(entity: str, action: str, params: dict | None = None) -> str:
"""Execute Clickup-Api connector operations."""
result = await connector.execute(entity, action, params or {})
return json.dumps(result, default=str)
API
curl -X POST 'https://api.airbyte.ai/api/v1/integrations/connectors/<connector_id>/execute' \
-H 'Authorization: Bearer <YOUR_BEARER_TOKEN>' \
-H 'X-Organization-Id: <YOUR_ORGANIZATION_ID>' \
-H 'Content-Type: application/json' \
-d '{"entity": "<entity>", "action": "<action>", "params": {}}'