nodes/generated

Interface ClickUpNodeParameters

Source
interface ClickUpNodeParameters {
    additionalFields?:
        | { assignee?: string }
        | { assignee?: string; notifyAll?: boolean }
        | {
            color?: string;
            description?: string;
            dueDate?: string;
            multipleOwners?: boolean;
            owners?: string;
        }
        | {
            listIds?: string;
            owners?: string;
            stepsEnd?: number;
            stepsStart?: number;
            taskIds?: string;
            unit?: string;
        }
        | { custom_task_ids?: boolean; team_id?: string }
        | {
            assignees?: unknown[];
            content?: string;
            customFieldsJson?: string;
            dueDate?: string;
            dueDateTime?: boolean;
            markdownContent?: boolean;
            notifyAll?: boolean;
            parentId?: string;
            priority?: number;
            startDate?: string;
            startDateTime?: boolean;
            status?: string;
            tags?: unknown[];
            timeEstimate?: number;
        }
        | {
            assignee?: string;
            billable?: boolean;
            description?: string;
            tags?: unknown[];
        }
        | { billable?: boolean; description?: string }
        | {
            assignee?: string;
            content?: string;
            dueDate?: string;
            dueDateTime?: boolean;
            priority?: number;
            status?: string;
        };
    archived?: boolean;
    authentication?: "oAuth2"
    | "accessToken";
    backgroundColor?: string;
    checklist?: string;
    checklistItem?: string;
    comment?: string;
    commentOn?: "list" | "task" | "view";
    commentsOn?: "list" | "task" | "view";
    commentText?: string;
    dependsOnTask?: string;
    duration?: number;
    field?: string;
    filters?:
        | { archived?: boolean }
        | {
            archived?: boolean;
            assignees?: unknown[];
            customFieldsUi?: {
                customFieldsValues: {
                    fieldId?: string;
                    operator?:
                        | "equal"
                        | "!="
                        | "<"
                        | "<="
                        | ">"
                        | ">="
                        | "IS NOT NULL"
                        | "IS NULL";
                    value?: string;
                }[];
            };
            dateCreatedGt?: string;
            dateCreatedLt?: string;
            dateUpdatedGt?: string;
            dateUpdatedLt?: string;
            dueDateGt?: string;
            dueDateLt?: string;
            includeClosed?: boolean;
            orderBy?: "id"
            | "created"
            | "updated"
            | "dueDate";
            statuses?: unknown[];
            subtasks?: boolean;
            tags?: unknown[];
        }
        | { end_date?: string; start_date?: string };
    folder?: string;
    folderless?: boolean;
    foregroundColor?: string;
    goal?: string;
    id?: string;
    includeMarkdownDescription?: boolean;
    includeSubtasks?: boolean;
    jsonParse?: boolean;
    keyResult?: string;
    limit?: number;
    list?: string;
    listId?: string;
    name?: string;
    newName?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "add"
        | "remove"
        | "delete"
        | "member"
        | "setCustomField"
        | "start"
        | "stop"
        | "customFields";
    resource?: | "list"
    | "comment"
    | "task"
    | "taskTag"
    | "folder"
    | "goal"
    | "checklist"
    | "checklistItem"
    | "goalKeyResult"
    | "spaceTag"
    | "taskDependency"
    | "taskList"
    | "timeEntry"
    | "timeEntryTag";
    returnAll?: boolean;
    running?: boolean;
    space?: string;
    start?: string;
    tagName?: string;
    tagNames?: unknown[];
    tagsUi?: {
        tagsValues: {
            name?: string;
            tag_bg?: string;
            tag_fg?: string;
        }[];
    };
    task?: string;
    taskId?: string;
    team?: string;
    timeEntry?: string;
    timeEntryIds?: string;
    type?: | "number"
    | "boolean"
    | "automatic"
    | "currency"
    | "percentage";
    updateFields?: | { name?: string; position?: number }
    | {
        assignee?: string;
        name?: string;
        parent?: string;
        resolved?: boolean;
    }
    | {
        assignee?: string;
        commentText?: string;
        resolved?: boolean;
    }
    | { name?: string }
    | {
        addOwners?: string;
        color?: string;
        description?: string;
        dueDate?: string;
        name?: string;
        removeOwners?: string;
    }
    | {
        name?: string;
        note?: string;
        stepsCurrent?: number;
        stepsEnd?: number;
        stepsStart?: number;
        unit?: string;
    }
    | {
        addAssignees?: string;
        content?: string;
        dueDate?: string;
        dueDateTime?: boolean;
        markdownContent?: boolean;
        name?: string;
        notifyAll?: boolean;
        parentId?: string;
        priority?: number;
        removeAssignees?: string;
        startDate?: string;
        startDateTime?: boolean;
        status?: string;
        timeEstimate?: number;
    }
    | {
        assignee?: string;
        billable?: boolean;
        description?: string;
        duration?: number;
        start?: string;
        tags?: unknown[];
        task?: string;
    }
    | {
        assignee?: string;
        content?: string;
        dueDate?: string;
        dueDateTime?: boolean;
        name?: string;
        priority?: number;
        unsetStatus?: boolean;
    };
    value?: string;
}

Properties§

Source§

readonly additionalFields?:
    | { assignee?: string }
    | { assignee?: string; notifyAll?: boolean }
    | {
        color?: string;
        description?: string;
        dueDate?: string;
        multipleOwners?: boolean;
        owners?: string;
    }
    | {
        listIds?: string;
        owners?: string;
        stepsEnd?: number;
        stepsStart?: number;
        taskIds?: string;
        unit?: string;
    }
    | { custom_task_ids?: boolean; team_id?: string }
    | {
        assignees?: unknown[];
        content?: string;
        customFieldsJson?: string;
        dueDate?: string;
        dueDateTime?: boolean;
        markdownContent?: boolean;
        notifyAll?: boolean;
        parentId?: string;
        priority?: number;
        startDate?: string;
        startDateTime?: boolean;
        status?: string;
        tags?: unknown[];
        timeEstimate?: number;
    }
    | {
        assignee?: string;
        billable?: boolean;
        description?: string;
        tags?: unknown[];
    }
    | { billable?: boolean; description?: string }
    | {
        assignee?: string;
        content?: string;
        dueDate?: string;
        dueDateTime?: boolean;
        priority?: number;
        status?: string;
    }

Default: {}

Source§

readonly archived?: boolean

Source§

readonly authentication?: "oAuth2" | "accessToken"

Default: "accessToken"

Source§

readonly backgroundColor?: string

Default: "#000000"

Source§

readonly checklist?: string

Source§

readonly checklistItem?: string

Source§

readonly comment?: string

Source§

readonly commentOn?: "list" | "task" | "view"

Source§

readonly commentsOn?: "list" | "task" | "view"

Source§

readonly commentText?: string

Source§

readonly dependsOnTask?: string

Source§

readonly duration?: number

Duration in minutes

Source§

readonly field?: string

The ID of the field to add custom field to

Source§

readonly filters?:
    | { archived?: boolean }
    | {
        archived?: boolean;
        assignees?: unknown[];
        customFieldsUi?: {
            customFieldsValues: {
                fieldId?: string;
                operator?:
                    | "equal"
                    | "!="
                    | "<"
                    | "<="
                    | ">"
                    | ">="
                    | "IS NOT NULL"
                    | "IS NULL";
                value?: string;
            }[];
        };
        dateCreatedGt?: string;
        dateCreatedLt?: string;
        dateUpdatedGt?: string;
        dateUpdatedLt?: string;
        dueDateGt?: string;
        dueDateLt?: string;
        includeClosed?: boolean;
        orderBy?: "id"
        | "created"
        | "updated"
        | "dueDate";
        statuses?: unknown[];
        subtasks?: boolean;
        tags?: unknown[];
    }
    | { end_date?: string; start_date?: string }

Default: {}

Source§

readonly folder?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getFolders","loadOptionsDependsOn":["space"]}

Source§

readonly folderless?: boolean

Source§

readonly foregroundColor?: string

Default: "#000000"

Source§

readonly goal?: string

Source§

readonly id?: string

Source§

readonly includeMarkdownDescription?: boolean

Whether to include the markdown_description field in the response. This is important for preserving links in the description.

Source§

readonly includeSubtasks?: boolean

Whether to also fetch and include subtasks for this task

Source§

readonly jsonParse?: boolean

The value is JSON and will be parsed as such. Is needed if for example needed for labels which expects the value to be an array.

Source§

readonly keyResult?: string

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":100}

Source§

readonly list?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getFolderlessLists","loadOptionsDependsOn":["space"]}

Source§

readonly listId?: string

Source§

readonly name?: string

Source§

readonly newName?: string

New name to set for the tag

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "member"
    | "setCustomField"
    | "start"
    | "stop"
    | "customFields"

Default: "create"

Source§

readonly resource?:
    | "list"
    | "comment"
    | "task"
    | "taskTag"
    | "folder"
    | "goal"
    | "checklist"
    | "checklistItem"
    | "goalKeyResult"
    | "spaceTag"
    | "taskDependency"
    | "taskList"
    | "timeEntry"
    | "timeEntryTag"

Default: "task"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit Default: true

Source§

readonly running?: boolean

Whether to return just the current running time entry

Source§

readonly space?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getSpaces","loadOptionsDependsOn":["team"]}

Source§

readonly start?: string

Source§

readonly tagName?: string

Source§

readonly tagNames?: unknown[]

Choose from the list, or specify IDs using an expression Default: [] Type options: {"loadOptionsMethod":"getTimeEntryTags","loadOptionsDependsOn":["teamId"]}

Source§

readonly tagsUi?: {
    tagsValues: {
        name?: string;
        tag_bg?: string;
        tag_fg?: string;
    }[];
}

Default: {} Type options: {"multipleValues":true}

Source§

readonly task?: string

Source§

readonly taskId?: string

Source§

readonly team?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getTeams"}

Source§

readonly timeEntry?: string

Source§

readonly timeEntryIds?: string

Source§

readonly type?:
    | "number"
    | "boolean"
    | "automatic"
    | "currency"
    | "percentage"

Source§

readonly updateFields?:
    | { name?: string; position?: number }
    | {
        assignee?: string;
        name?: string;
        parent?: string;
        resolved?: boolean;
    }
    | {
        assignee?: string;
        commentText?: string;
        resolved?: boolean;
    }
    | { name?: string }
    | {
        addOwners?: string;
        color?: string;
        description?: string;
        dueDate?: string;
        name?: string;
        removeOwners?: string;
    }
    | {
        name?: string;
        note?: string;
        stepsCurrent?: number;
        stepsEnd?: number;
        stepsStart?: number;
        unit?: string;
    }
    | {
        addAssignees?: string;
        content?: string;
        dueDate?: string;
        dueDateTime?: boolean;
        markdownContent?: boolean;
        name?: string;
        notifyAll?: boolean;
        parentId?: string;
        priority?: number;
        removeAssignees?: string;
        startDate?: string;
        startDateTime?: boolean;
        status?: string;
        timeEstimate?: number;
    }
    | {
        assignee?: string;
        billable?: boolean;
        description?: string;
        duration?: number;
        start?: string;
        tags?: unknown[];
        task?: string;
    }
    | {
        assignee?: string;
        content?: string;
        dueDate?: string;
        dueDateTime?: boolean;
        name?: string;
        priority?: number;
        unsetStatus?: boolean;
    }

Default: {}

Source§

readonly value?: string

The value to set on custom field