ClickUp API
Tools that enable LLMs to interact directly with the upclick API.
UpclickApi toolkit enables developers to integrate with the Upclick API, facilitating seamless interactions for task and checklist management. The toolkit supports various operations that enhance productivity workflows within Upclick.
Capabilities
- Create and manage checklists, tasks, and custom fields in a specified Upclick space.
- Fetch details of tasks and lists, applying filters as necessary.
- Track time entries for tasks, improving time management.
- Perform operations based on a defined request schema to ensure successful executions.
OAuth
- Provider: ClickUp
- Scopes: None
Available tools(7)
| Tool name | Description | Secrets | |
|---|---|---|---|
Creates a checklist on a task with multiple items.
Use this tool to create a checklist within an existing task by specifying the task ID and the checklist items.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a custom field in a specified space.
This tool creates a custom field within a given space, allowing for complex type-specific configuration. Use this when you need to add or configure custom fields in a space.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Creates a new task with detailed configuration.
Use this tool to add a new task to a specified list on Upclick, enabling configuration of custom fields, assignees, and dependencies.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path, query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path, query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Create a new list in a space with configurations.
Use this tool to create a new list within a specified space, including setting status configurations and assigning settings.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Fetch all tasks from a specified list with optional filters.
Use this tool to retrieve all tasks from a particular list. You can apply filters to the results if needed. | |||
Retrieve details of a specific task.
Use this tool to obtain details about a specific task by providing its ID. This is ideal for when you need information on a particular task's status, description, and other related details. | |||
Creates a time tracking entry for a task.
This tool should be called to log time spent on a specific task with detailed metadata, enhancing productivity tracking.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path, query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path, query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
|
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
UpclickApi.CreateChecklist
Creates a checklist on a task with multiple items. Use this tool to create a checklist within an existing task by specifying the task ID and the checklist items. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
task_id | string | Required | The ID of the task to which the checklist will be added. This should be a string representing the unique identifier of the task. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createChecklist'.UpclickApi.CreateCustomField
Create a custom field in a specified space. This tool creates a custom field within a given space, allowing for complex type-specific configuration. Use this when you need to add or configure custom fields in a space. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
space_identifier | string | Required | The unique identifier of the space where the custom field is to be created. It should be provided as a string. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createCustomField'.UpclickApi.CreateTaskInList
Creates a new task with detailed configuration. Use this tool to add a new task to a specified list on Upclick, enabling configuration of custom fields, assignees, and dependencies. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_id | string | Required | The unique identifier for the list where the task will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
team_identifier | string | Optional | Specify the team ID if using custom task IDs. Required when custom task IDs are enabled. Only used when mode is 'execute'. |
use_custom_task_ids | boolean | Optional | Set to true to reference the task by its custom task ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createTask'.UpclickApi.CreateUpclickList
Create a new list in a space with configurations. Use this tool to create a new list within a specified space, including setting status configurations and assigning settings. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
space_identifier | string | Required | The unique identifier of the space where the new list will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'createList'.UpclickApi.GetTasksInList
Fetch all tasks from a specified list with optional filters. Use this tool to retrieve all tasks from a particular list. You can apply filters to the results if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_identifier | string | Required | The unique identifier for the list from which to retrieve tasks. |
page_number | integer | Optional | The page number to retrieve for paginated results. |
order_tasks_by | string | Optional | Specify the field to order tasks by. Options are 'id', 'created', 'updated', 'due_date'. |
filter_by_statuses | string | Optional | Comma-separated list to filter tasks by their statuses. |
filter_by_assignees | string | Optional | Comma-separated user IDs to filter tasks by specific assignees. |
filter_by_tags | string | Optional | Comma-separated list of tags to filter tasks by specific tags. |
filter_due_date_after | integer | Optional | Filter tasks with a due date later than a specified Unix timestamp in milliseconds. |
filter_due_date_before | integer | Optional | Filter tasks with a due date less than this Unix timestamp in milliseconds. |
filter_created_after | integer | Optional | Filter tasks created after a specified Unix timestamp in milliseconds. |
created_before_date | integer | Optional | Filter tasks created before the specified date in Unix milliseconds. |
filter_date_updated_after | integer | Optional | Filter tasks to include only those updated after the specified Unix time in milliseconds. |
filter_tasks_updated_before | integer | Optional | Filter tasks updated before this Unix timestamp in milliseconds. |
filter_by_custom_fields | string | Optional | Provide a JSON array to filter tasks by specific custom fields. |
include_archived_tasks | boolean | Optional | Specify whether to include archived tasks in the results. Set true to include them. |
reverse_order | boolean | Optional | Set to true to reverse the order of the tasks. |
include_subtasks | boolean | Optional | Indicates whether to include subtasks. Set to true to include. |
include_closed_tasks | boolean | Optional | Include tasks with a closed status in the results. |
Requirements
Output
json— Response from the API endpoint 'getTasks'.UpclickApi.RetrieveTaskDetails
Retrieve details of a specific task. Use this tool to obtain details about a specific task by providing its ID. This is ideal for when you need information on a particular task's status, description, and other related details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
task_identifier | string | Required | The unique identifier of the task to retrieve details for. |
team_id | string | Optional | Provide the team ID. Required if using custom task IDs. |
use_custom_task_ids | boolean | Optional | Use true to enable custom task IDs instead of default ones. |
include_subtasks | boolean | Optional | A boolean indicating whether to include subtasks in the response. |
Requirements
Output
json— Response from the API endpoint 'getTask'.UpclickApi.TrackTimeEntry
Creates a time tracking entry for a task. This tool should be called to log time spent on a specific task with detailed metadata, enhancing productivity tracking. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
task_identifier | string | Required | The unique identifier for the task to track time against. It is required for logging the task's time entry. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
team_id | string | Optional | The unique identifier for the team. This is required when using custom task IDs. Only used when mode is 'execute'. |
use_custom_task_ids | boolean | Optional | Set to true to use custom task IDs when tracking time. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'trackTime'.