TickTick API
Tools that enable LLMs to interact directly with the ticktick API.
1.0.0Available tools(11)
| Tool name | Description | Secrets | |
|---|---|---|---|
Create a new project in Ticktick with optional properties.
Use this tool to create a new project in Ticktick. You can specify the project's name and other optional properties such as color, sort order, view mode, and kind (TASK or NOTE). | |||
Create a new task in Ticktick with specified properties.
Use this tool to create a new task in Ticktick by specifying title, content, dates, reminders, subtasks, and the project it belongs to.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
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.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Permanently delete a task using project and task IDs.
This tool is used to permanently remove a specific task by providing its project ID and task ID from Ticktick. Use this when you need to delete a task and ensure it is no longer available in the project. | |||
Permanently delete a project in Ticktick by ID.
Use this tool to permanently remove a specific project and all associated tasks from Ticktick by providing the project's ID. Ensure you no longer need the project, as this action cannot be undone. | |||
Retrieve Ticktick project details by project ID.
This tool retrieves detailed information about a specific project in Ticktick using its ID. It provides the project's name, color, view mode, and kind. | |||
Retrieve all user-accessible projects from Ticktick.
This tool fetches a list of all projects that the authenticated user has access to in Ticktick. It should be called when a user wants to view or manage their projects within the platform. | |||
Marks a specific task as completed in Ticktick.
Use this tool to mark a task as completed in Ticktick, updating its status and setting the completion time. | |||
Retrieve detailed project information and all related tasks.
Call this tool to get a complete view of a project, including tasks and column configurations, especially useful for understanding project status and organization. | |||
Retrieve detailed information for a specific task.
Use this tool to get detailed information about a task by providing the project ID and task ID. It returns information including subtasks, reminders, and scheduling details. | |||
Update properties of an existing project.
This tool updates various properties of an existing project, such as name, color, sort order, view mode, and kind. It should be used when changes to these attributes are needed for a project on Ticktick. | |||
Update a task's properties in Ticktick.
Use this tool to update various properties of a task in Ticktick. It requires the task ID and project ID, while other fields are optional. Ideal for modifying task details such as status, title, or due date.
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.
|
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
TicktickApi.CreateProjectInTicktick
Create a new project in Ticktick with optional properties. Use this tool to create a new project in Ticktick. You can specify the project's name and other optional properties such as color, sort order, view mode, and kind (TASK or NOTE).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_name | string | Required | Name of the project to be created. This is a required field. |
project_color | string | Optional | Hex color code representing the project's color (e.g., '#F18181'). |
project_kind | string | Optional | Specifies the type of items the project will store. Choose 'TASK' for tasks or 'NOTE' for notes. |
project_sort_order | integer | Optional | The integer value representing the project's sort order. |
project_view_mode | string | Optional | The display mode for the project: choose from 'list', 'kanban', or 'timeline'. |
Requirements
Output
json— Response from the API endpoint 'createProject'.TicktickApi.CreateTaskTicktick
Create a new task in Ticktick with specified properties. Use this tool to create a new task in Ticktick by specifying title, content, dates, reminders, subtasks, and the project it belongs to. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. 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. 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 |
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'.TicktickApi.DeleteSpecificTask
Permanently delete a task using project and task IDs. This tool is used to permanently remove a specific task by providing its project ID and task ID from Ticktick. Use this when you need to delete a task and ensure it is no longer available in the project.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_id | string | Required | The unique ID of the project containing the task to be deleted. |
task_identifier_to_delete | string | Required | The unique ID of the task to permanently delete from a project. |
Requirements
Output
json— Response from the API endpoint 'deleteTask'.TicktickApi.DeleteTicktickProject
Permanently delete a project in Ticktick by ID. Use this tool to permanently remove a specific project and all associated tasks from Ticktick by providing the project's ID. Ensure you no longer need the project, as this action cannot be undone.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_id | string | Required | The unique ID of the Ticktick project to permanently delete. Ensure the ID is correct, as this action cannot be undone. |
Requirements
Output
json— Response from the API endpoint 'deleteProject'.TicktickApi.GetTicktickProjectById
Retrieve Ticktick project details by project ID. This tool retrieves detailed information about a specific project in Ticktick using its ID. It provides the project's name, color, view mode, and kind.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_id | string | Required | The unique ID of the Ticktick project to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getProjectById'.TicktickApi.GetUserProjects
Retrieve all user-accessible projects from Ticktick. This tool fetches a list of all projects that the authenticated user has access to in Ticktick. It should be called when a user wants to view or manage their projects within the platform.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getUserProjects'.TicktickApi.MarkTaskComplete
Marks a specific task as completed in Ticktick. Use this tool to mark a task as completed in Ticktick, updating its status and setting the completion time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_id | string | Required | Unique ID of the project containing the task to be completed. |
task_identifier | string | Required | The unique ID of the task to be marked as completed. |
Requirements
Output
json— Response from the API endpoint 'completeTask'.TicktickApi.RetrieveProjectWithTasks
Retrieve detailed project information and all related tasks. Call this tool to get a complete view of a project, including tasks and column configurations, especially useful for understanding project status and organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_id | string | Required | The unique ID of the project to retrieve with all data, including tasks and columns. |
Requirements
Output
json— Response from the API endpoint 'getProjectWithData'.TicktickApi.RetrieveTaskDetails
Retrieve detailed information for a specific task. Use this tool to get detailed information about a task by providing the project ID and task ID. It returns information including subtasks, reminders, and scheduling details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_identifier | string | Required | The unique ID of the project containing the task to retrieve. |
task_identifier | string | Required | Unique identifier for the task to retrieve detailed information including subtasks and reminders. |
Requirements
Output
json— Response from the API endpoint 'getTaskById'.TicktickApi.UpdateProjectProperties
Update properties of an existing project. This tool updates various properties of an existing project, such as name, color, sort order, view mode, and kind. It should be used when changes to these attributes are needed for a project on Ticktick.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_identifier | string | Required | Unique ID of the project to update. |
project_color | string | Optional | Hex color code representing the color of the project, such as '#FFFFFF'. |
project_kind | string | Optional | Specify the type of project: TASK or NOTE. |
project_name | string | Optional | The new name for the project to be updated. This should be a string representing the desired project name. |
project_sort_order | integer | Optional | Sort order value for the project, default is 0. Determines the project's position relative to others. |
project_view_mode | string | Optional | Specifies the view mode of the project. Options are 'list', 'kanban', or 'timeline'. |
Requirements
Output
json— Response from the API endpoint 'updateProject'.TicktickApi.UpdateTaskProperties
Update a task's properties in Ticktick. Use this tool to update various properties of a task in Ticktick. It requires the task ID and project ID, while other fields are optional. Ideal for modifying task details such as status, title, or due date. 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_identifier | string | Optional | The unique ID of the task to update in Ticktick. This is required to identify the specific task to be updated. 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 'updateTask'.