Clickup-Api full reference

This connector is optimized for AI agents. For the data replication connector, see Clickup Api.

This is the full reference documentation for the Clickup-Api agent connector.

Supported entities and actions

The Clickup-Api connector supports the following entities and actions.

Entity	Actions
User	Get
Teams	List
Spaces	List, Get
Folders	List, Get
Lists	List, Get
Tasks	List, Get, API Search
Comments	List, Create, Get, Update
Goals	List, Get
Views	List, Get
View Tasks	List
Time Tracking	List, Get
Members	List
Docs	List, Get

User

User Get

View the details of the authenticated user's ClickUp account

Python SDK

await clickup_api.user.get()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "user",
    "action": "get"
}'

Response Schema

Records

Field Name	Type	Description
id	integer
username	string
email	string
color	string | null
profilePicture	string | null
initials	string | null
week_start_day	integer | null
global_font_support	boolean | null
timezone	string | null

Teams

Teams List

Get the workspaces (teams) available to the authenticated user

Python SDK

await clickup_api.teams.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "teams",
    "action": "list"
}'

Response Schema

Records

Field Name	Type	Description
id	string
name	string
color	string | null
avatar	string | null
members	array<object>

Spaces

Spaces List

Get the spaces available in a workspace

Python SDK

await clickup_api.spaces.list(
    team_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "spaces",
    "action": "list",
    "params": {
        "team_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
team_id	string	Yes	The ID of the workspace

Response Schema

Records

Field Name	Type	Description
id	string
name	string
private	boolean
color	string | null
avatar	string | null
admin_can_manage	boolean | null
statuses	array<object>
multiple_assignees	boolean
features	object
archived	boolean

Spaces Get

Get a single space by ID

Python SDK

await clickup_api.spaces.get(
    space_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "spaces",
    "action": "get",
    "params": {
        "space_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
space_id	string	Yes	The ID of the space

Response Schema

Records

Field Name	Type	Description
id	string
name	string
private	boolean
color	string | null
avatar	string | null
admin_can_manage	boolean | null
statuses	array<object>
multiple_assignees	boolean
features	object
archived	boolean

Folders

Folders List

Get the folders in a space

Python SDK

await clickup_api.folders.list(
    space_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "folders",
    "action": "list",
    "params": {
        "space_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
space_id	string	Yes	The ID of the space

Response Schema

Records

Field Name	Type	Description
id	string
name	string
orderindex	integer | null
override_statuses	boolean
hidden	boolean
space	object
task_count	string | null
archived	boolean
statuses	array<object>
deleted	boolean | null
lists	array<object>
permission_level	string | null

Folders Get

Get a single folder by ID

Python SDK

await clickup_api.folders.get(
    folder_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "folders",
    "action": "get",
    "params": {
        "folder_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
folder_id	string	Yes	The ID of the folder

Response Schema

Records

Field Name	Type	Description
id	string
name	string
orderindex	integer | null
override_statuses	boolean
hidden	boolean
space	object
task_count	string | null
archived	boolean
statuses	array<object>
deleted	boolean | null
lists	array<object>
permission_level	string | null

Lists

Lists List

Get the lists in a folder

Python SDK

await clickup_api.lists.list(
    folder_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "lists",
    "action": "list",
    "params": {
        "folder_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
folder_id	string	Yes	The ID of the folder

Response Schema

Records

Field Name	Type	Description
id	string
name	string
orderindex	integer | null
status	object | null
priority	object | null
assignee	object | null
task_count	integer | null
due_date	string | null
start_date	string | null
folder	object
space	object
archived	boolean
override_statuses	boolean | null
content	string | null
deleted	boolean | null
inbound_address	string | null
statuses	array<object>
permission_level	string | null

Lists Get

Get a single list by ID

Python SDK

await clickup_api.lists.get(
    list_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "lists",
    "action": "get",
    "params": {
        "list_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
list_id	string	Yes	The ID of the list

Response Schema

Records

Field Name	Type	Description
id	string
name	string
orderindex	integer | null
status	object | null
priority	object | null
assignee	object | null
task_count	integer | null
due_date	string | null
start_date	string | null
folder	object
space	object
archived	boolean
override_statuses	boolean | null
content	string | null
deleted	boolean | null
inbound_address	string | null
statuses	array<object>
permission_level	string | null

Tasks

Tasks List

Get the tasks in a list

Python SDK

await clickup_api.tasks.list(
    list_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "tasks",
    "action": "list",
    "params": {
        "list_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
list_id	string	Yes	The ID of the list
page	integer	No	Page number (0-indexed)

Response Schema

Records

Field Name	Type	Description
id	string
custom_id	string | null
custom_item_id	integer | null
name	string
text_content	string | null
description	string | null
status	object
orderindex	string | null
date_created	string | null
date_updated	string | null
date_closed	string | null
date_done	string | null
archived	boolean
creator	object
assignees	array<object>
group_assignees	array<object>
watchers	array<object>
checklists	array<object>
tags	array<object>
parent	string | null
priority	object | null
due_date	string | null
start_date	string | null
points	number | null
time_estimate	integer | null
time_spent	integer | null
custom_fields	array<object>
dependencies	array<object>
linked_tasks	array<object>
team_id	string | null
url	string
list	object | null
project	object | null
folder	object | null
space	object | null
top_level_parent	string | null
locations	array<object>
sharing	object | null
permission_level	string | null
attachments	array<object>

Tasks Get

Get a single task by ID

Python SDK

await clickup_api.tasks.get(
    task_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "tasks",
    "action": "get",
    "params": {
        "task_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
task_id	string	Yes	The ID of the task
custom_task_ids	boolean	No	Set to true to use a custom task ID
include_subtasks	boolean	No	Include subtasks

Response Schema

Records

Field Name	Type	Description
id	string
custom_id	string | null
custom_item_id	integer | null
name	string
text_content	string | null
description	string | null
status	object
orderindex	string | null
date_created	string | null
date_updated	string | null
date_closed	string | null
date_done	string | null
archived	boolean
creator	object
assignees	array<object>
group_assignees	array<object>
watchers	array<object>
checklists	array<object>
tags	array<object>
parent	string | null
priority	object | null
due_date	string | null
start_date	string | null
points	number | null
time_estimate	integer | null
time_spent	integer | null
custom_fields	array<object>
dependencies	array<object>
linked_tasks	array<object>
team_id	string | null
url	string
list	object | null
project	object | null
folder	object | null
space	object | null
top_level_parent	string | null
locations	array<object>
sharing	object | null
permission_level	string | null
attachments	array<object>

Tasks API Search

View the tasks that meet specific criteria from a workspace. Supports free-text search and structured filters including status, assignee, tags, priority, and date ranges. Responses are limited to 100 tasks per page.

Python SDK

await clickup_api.tasks.api_search(
    team_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "tasks",
    "action": "api_search",
    "params": {
        "team_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
team_id	string	Yes	The workspace ID to search within
search	string	No	Free-text search across task name, description, and custom field text
statuses[]	array<string>	No	Filter by status names (e.g. "in progress", "done")
assignees[]	array<string>	No	Filter by user IDs
tags[]	array<string>	No	Filter by tag names
priority	integer	No	Filter by priority: 1=Urgent, 2=High, 3=Normal, 4=Low
due_date_gt	integer	No	Due date after (Unix ms)
due_date_lt	integer	No	Due date before (Unix ms)
date_created_gt	integer	No	Created after (Unix ms)
date_created_lt	integer	No	Created before (Unix ms)
date_updated_gt	integer	No	Updated after (Unix ms)
date_updated_lt	integer	No	Updated before (Unix ms)
custom_fields	array<object>	No	JSON array of custom field filters. Each object: {"field_id": "<UUID>", "operator": "<OP>", "value": "<DATA>"}.
Operators: = (contains), == (exact), <, <=, >, >=, !=, !==, IS NULL, IS NOT NULL, RANGE, ANY, ALL, NOT ANY, NOT ALL
include_closed	boolean	No	Include closed tasks (excluded by default)
page	integer	No	Page number (0-indexed), results capped at 100/page

Response Schema

Records

Field Name	Type	Description
id	string
custom_id	string | null
custom_item_id	integer | null
name	string
text_content	string | null
description	string | null
status	object
orderindex	string | null
date_created	string | null
date_updated	string | null
date_closed	string | null
date_done	string | null
archived	boolean
creator	object
assignees	array<object>
group_assignees	array<object>
watchers	array<object>
checklists	array<object>
tags	array<object>
parent	string | null
priority	object | null
due_date	string | null
start_date	string | null
points	number | null
time_estimate	integer | null
time_spent	integer | null
custom_fields	array<object>
dependencies	array<object>
linked_tasks	array<object>
team_id	string | null
url	string
list	object | null
project	object | null
folder	object | null
space	object | null
top_level_parent	string | null
locations	array<object>
sharing	object | null
permission_level	string | null
attachments	array<object>

Comments

Comments List

Get the comments on a task

Python SDK

await clickup_api.comments.list(
    task_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "comments",
    "action": "list",
    "params": {
        "task_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
task_id	string	Yes	The ID of the task

Response Schema

Records

Field Name	Type	Description
id	string
comment	array<object>
comment_text	string
user	object
resolved	boolean
assignee	object | null
assigned_by	object | null
reactions	array<object>
date	string

Comments Create

Create a comment on a task

Python SDK

await clickup_api.comments.create(
    comment_text="<str>",
    assignee=0,
    notify_all=True,
    task_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "comments",
    "action": "create",
    "params": {
        "comment_text": "<str>",
        "assignee": 0,
        "notify_all": True,
        "task_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
comment_text	string	Yes	The comment text
assignee	integer	No	User ID to assign
notify_all	boolean	No	Notify all assignees and watchers
task_id	string	Yes	The ID of the task

Response Schema

Records

Field Name	Type	Description
id	integer
hist_id	string
date	integer
version	object | null

Comments Get

Get threaded replies on a comment

Python SDK

await clickup_api.comments.get(
    comment_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "comments",
    "action": "get",
    "params": {
        "comment_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
comment_id	string	Yes	The ID of the comment

Response Schema

Records

Field Name	Type	Description
id	string
comment	array<object>
comment_text	string
user	object
resolved	boolean
assignee	object | null
assigned_by	object | null
reactions	array<object>
date	string

Comments Update

Update an existing comment

Python SDK

await clickup_api.comments.update(
    comment_text="<str>",
    assignee=0,
    resolved=True,
    comment_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "comments",
    "action": "update",
    "params": {
        "comment_text": "<str>",
        "assignee": 0,
        "resolved": True,
        "comment_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
comment_text	string	No	Updated comment text
assignee	integer	No	User ID to assign
resolved	boolean	No	Whether the comment is resolved
comment_id	string	Yes	The ID of the comment

Goals

Goals List

Get the goals in a workspace

Python SDK

await clickup_api.goals.list(
    team_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "goals",
    "action": "list",
    "params": {
        "team_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
team_id	string	Yes	The ID of the workspace

Response Schema

Records

Field Name	Type	Description
id	string
pretty_id	string | null
name	string
team_id	string
creator	integer | null
owner	object | null
color	string
date_created	string | null
start_date	string | null
due_date	string | null
description	string | null
private	boolean
archived	boolean
multiple_owners	boolean
members	array<object>
key_results	array<object>
percent_completed	integer | null
history	array<object>
pretty_url	string | null

Goals Get

Get a single goal by ID

Python SDK

await clickup_api.goals.get(
    goal_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "goals",
    "action": "get",
    "params": {
        "goal_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
goal_id	string	Yes	The ID of the goal

Response Schema

Records

Field Name	Type	Description
id	string
pretty_id	string | null
name	string
team_id	string
creator	integer | null
owner	object | null
color	string
date_created	string | null
start_date	string | null
due_date	string | null
description	string | null
private	boolean
archived	boolean
multiple_owners	boolean
members	array<object>
key_results	array<object>
percent_completed	integer | null
history	array<object>
pretty_url	string | null

Views

Views List

Get the workspace-level (Everything level) views

Python SDK

await clickup_api.views.list(
    team_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "views",
    "action": "list",
    "params": {
        "team_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
team_id	string	Yes	The ID of the workspace

Response Schema

Records

Field Name	Type	Description
id	string
name	string
type	string
parent	object
grouping	object
divide	object
sorting	object
filters	object
columns	object
team_sidebar	object
settings	object
date_created	string | null
creator	integer | null
visibility	string | null
protected	boolean | null
protected_note	string | null
protected_by	integer | null
date_protected	string | null
orderindex	integer
public	boolean

Views Get

Get a single view by ID

Python SDK

await clickup_api.views.get(
    view_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "views",
    "action": "get",
    "params": {
        "view_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
view_id	string	Yes	The ID of the view

Response Schema

Records

Field Name	Type	Description
id	string
name	string
type	string
parent	object
grouping	object
divide	object
sorting	object
filters	object
columns	object
team_sidebar	object
settings	object
date_created	string | null
creator	integer | null
visibility	string | null
protected	boolean | null
protected_note	string | null
protected_by	integer | null
date_protected	string | null
orderindex	integer
public	boolean

View Tasks

View Tasks List

Get tasks matching a view's pre-configured filters — useful as a secondary search mechanism

Python SDK

await clickup_api.view_tasks.list(
    view_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "view_tasks",
    "action": "list",
    "params": {
        "view_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
view_id	string	Yes	The ID of the view
page	integer	No	Page number (0-indexed)

Response Schema

Records

Field Name	Type	Description
id	string
custom_id	string | null
custom_item_id	integer | null
name	string
text_content	string | null
description	string | null
status	object
orderindex	string | null
date_created	string | null
date_updated	string | null
date_closed	string | null
date_done	string | null
archived	boolean
creator	object
assignees	array<object>
group_assignees	array<object>
watchers	array<object>
checklists	array<object>
tags	array<object>
parent	string | null
priority	object | null
due_date	string | null
start_date	string | null
points	number | null
time_estimate	integer | null
time_spent	integer | null
custom_fields	array<object>
dependencies	array<object>
linked_tasks	array<object>
team_id	string | null
url	string
list	object | null
project	object | null
folder	object | null
space	object | null
top_level_parent	string | null
locations	array<object>
sharing	object | null
permission_level	string | null
attachments	array<object>

Time Tracking

Time Tracking List

Get time entries within a date range for a workspace

Python SDK

await clickup_api.time_tracking.list(
    team_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "time_tracking",
    "action": "list",
    "params": {
        "team_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
team_id	string	Yes	The ID of the workspace
start_date	integer	No	Start date (Unix ms)
end_date	integer	No	End date (Unix ms)
assignee	string	No	Filter by user ID

Response Schema

Records

Field Name	Type	Description
id	string
task	object | null
wid	string | null
user	object
billable	boolean
start	string
end	string | null
duration	string
description	string | null
tags	array<object>
at	string | null

Time Tracking Get

Get a single time entry by ID

Python SDK

await clickup_api.time_tracking.get(
    team_id="<str>",
    time_entry_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "time_tracking",
    "action": "get",
    "params": {
        "team_id": "<str>",
        "time_entry_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
team_id	string	Yes	The ID of the workspace
time_entry_id	string	Yes	The ID of the time entry

Response Schema

Records

Field Name	Type	Description
id	string
task	object | null
wid	string | null
user	object
billable	boolean
start	string
end	string | null
duration	string
description	string | null
tags	array<object>
at	string | null

Members

Members List

Get the members assigned to a task

Python SDK

await clickup_api.members.list(
    task_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "members",
    "action": "list",
    "params": {
        "task_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
task_id	string	Yes	The ID of the task

Response Schema

Records

Field Name	Type	Description
id	integer
username	string
email	string
color	string | null
profilePicture	string | null
initials	string | null

Docs

Docs List

Search for docs in a workspace

Python SDK

await clickup_api.docs.list(
    workspace_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "docs",
    "action": "list",
    "params": {
        "workspace_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
workspace_id	string	Yes	The ID of the workspace

Response Schema

Records

Field Name	Type	Description
id	string
name	string
type	integer | null
parent	object | null
creator	integer | null
deleted	boolean | null
public	boolean | null
date_created	integer | null
date_updated	integer | null
workspace_id	integer | null
content	string | null

Docs Get

Fetch a single doc by ID

Python SDK

await clickup_api.docs.get(
    workspace_id="<str>",
    doc_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "docs",
    "action": "get",
    "params": {
        "workspace_id": "<str>",
        "doc_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
workspace_id	string	Yes	The ID of the workspace
doc_id	string	Yes	The ID of the doc

Response Schema

Records

Field Name	Type	Description
id	string
name	string
type	integer | null
parent	object | null
creator	integer | null
deleted	boolean | null
public	boolean | null
date_created	integer | null
date_updated	integer | null
workspace_id	integer | null
content	string | null