clickup_get_task_by_custom_id
Retrieve ClickUp tasks using custom identifiers to access specific task details and information within your workspace.
Instructions
Get a task by its custom ID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| custom_id | Yes |
Implementation Reference
- src/controllers/task.controller.ts:38-51 (handler)Tool handler for 'clickup_get_task_by_custom_id' that extracts custom_id from input and calls TaskService.getTaskByCustomId to fetch the task, returning JSON stringified response.
const getTaskByCustomIdTool = defineTool((z) => ({ name: "clickup_get_task_by_custom_id", description: "Get a task by its custom ID", inputSchema: { custom_id: z.string(), }, handler: async (input) => { const { custom_id } = input; const response = await taskService.getTaskByCustomId(custom_id); return { content: [{ type: "text", text: JSON.stringify(response) }], }; }, })); - Input schema defining 'custom_id' as a required string.
inputSchema: { custom_id: z.string(), }, - src/services/task.service.ts:40-44 (helper)Helper method in TaskService that performs the API GET request to ClickUp to retrieve task by custom ID using custom_task_ids=true parameter.
async getTaskByCustomId(customId: string): Promise<ClickUpTask> { return this.request<ClickUpTask>( `/task/${customId}?custom_task_ids=true&team_id=${this.workspaceId}&include_subtasks=true&include_markdown_description=true` ); }