clickupython package

Subpackages

Submodules

clickupython.client module

class clickupython.client.ClickUpClient(accesstoken: str, api_url: str = 'https://api.clickup.com/api/v2/', default_space: Optional[str] = None, default_list: Optional[str] = None, default_task: Optional[str] = None, retry_rate_limited_requests: bool = False, rate_limit_buffer_wait_time: int = 5, start_rate_limit_remaining: int = 100, start_rate_limit_reset: float = 1691162734.005813)

Bases: object

add_task_to_list(task_id: str, list_id: str) → Task

Adds a task to a list via a gen task id and list id.

Args:

task_id (str): The id of the task to be added to a list. list_id (str): The id of the list to add the task to.

Returns:

models.Task: Returns an object of type Task.

create_chat_comment(view_id: str, comment_text: str, notify_all: bool = True) → Comment

Create a comment on a chat via a given chat view id.

Args:

view_id (str):

The id of the chat to comment on.

comment_text (str):

The text of the comment.

notify_all (bool, optional):

Notify all valid users of the comment’s creation. Default to True.

Returns:

models.Comment:

Returns an object of type Comment.

create_checklist(task_id: str, name: str) → Checklist

Create a checklist in a task via a given task id.

Args:

task_id (str):

The id of the task to create a checklist in.

name (str):

The name for the new checklist.

Returns:

models.Checklist:

Returns and object of type Checklist.

create_checklist_item(checklist_id: str, name: str, assignee: Optional[str] = None) → Checklist

create_checklist_item Creates an item in a ClickUp checklist via a given checklist id.

Args:

checklist_id (str):

The id of the checklist to create a new item in.

name (str):

The name of the new checklist item.

assignee (str, optional):

The user id to assign the checklist item to. Defaults to None.

Returns:

models.Checklist:

Returns and object of type Checklist.

create_folder(space_id: str, name: str) → Folder

Creates and returns a Folder object in a space from a given space ID.

Args:

space_id (str):

The ID of the ClickUp space to create the folder inside.

name (str):

String value that the created folder will utilize as its name.

Returns:

Folder:

Returns the created Folder object.

create_folderless_list(space_id: str, name: str, content: Optional[str] = None, due_date: Optional[str] = None, priority: Optional[int] = None, assignee: Optional[str] = None, status: Optional[str] = None) → SingleList

create_goal(team_id, name: str, due_date: Optional[str] = None, description: Optional[str] = None, multiple_owners: bool = True, owners: Optional[List[int]] = None, color: Optional[str] = None) → Goal

Create a new goal for a team given a team id.

Args:

team_id ([type]):

[description]

name (str, optional):

The name of the goal.

due_date (str, optional):

The due date of the goal. Defaults to None.

description (str, optional):

The goal description. Defaults to None.

multiple_owners (bool, optional):

Indicated whether the goal should have multiple owners. Defaults to True.

owners (List[int], optional):

If multiple owners is True, a supplied list of user ids to assign as owners. Defaults to None.

color (str, optional):

Hex value for color of the goal. Defaults to None.

Returns:

models.Goal:

Returns an object of type Goal.

create_list(folder_id: str, name: str, content: str, due_date: str, priority: int, status: str) → SingleList

Creates and returns a List object in a folder from a given folder ID.

Args:

folder_id (str):

The ID of the ClickUp folder.

name (str):

The name of the created list.

content (str):

The description content of the created list.

due_date (str):

The due date of the created list.

priority (int):

An integer 1 : Urgent, 2 : High, 3 : Normal, 4 : Low.

status (str):

Refers to the List color rather than the task Statuses available in the List.

Returns:

list.SingleList:

Returns an object of type SingleList.

create_space(team_id: str, name: str, features: Features) → Space

create_space Create’s a new ClickUp space.

Args:

team_id (str):

Id of the team to create the space for.

name (str):

The name of the created space.

features (models.Features):

Features to enable or disable in the newly created space.

Returns:

models.Space:

Returns an object of type Space.

create_space_tag(space_id, name: str) → Tag

Creates a tag to be utilized in a space.

Args:

space_id ([type]):

The id of the space to create a tag for.

name (str):

the name of the created tag.

Returns:

models.Tag:

Returns an object of type Tag.

create_task(list_id: str, name: str, description: str = None, priority: int = None, assignees: [] = None, tags: [] = None, status: str = None, due_date: str = None, start_date: str = None, notify_all: bool = True) → Task

[summary]

Args:

list_id (str):

[description]

name (str):

[description]

description (str, optional):

[description]. Defaults to None.

priority (int, optional):

[description]. Defaults to None.

assignees ([type], optional):

[description]. Defaults to None.

tags ([type], optional):

[description]. Defaults to None.

status (str, optional):

[description]. Defaults to None.

due_date (str, optional):

[description]. Defaults to None.

start_date (str, optional):

[description]. Defaults to None.

notify_all (bool, optional):

[description]. Defaults to True.

Raises:

exceptions.ClickupClientError:

[description]

Returns:

models.Task:

[description]

create_task_comment(task_id: str, comment_text: str, assignee: Optional[str] = None, notify_all: bool = True) → Comment

Create a comment on a task via a given task id.

Args:

task_id (str):

The id of the task to comment on.

comment_text (str):

The text of the comment.

assignee (str, optional):

The id of a user to add as an assignee. Defaults to None.

notify_all (bool, optional):

Notify all valid users of the comment’s creation. Defaults to True.

Returns:

models.Comment:

Returns an object of type Comment.

delete_checklist(checklist_id: str) → bool

delete_checklist Delete a checklist via a given checklist id.

Args:

checklist_id (str):

The id of the ClickUp checklist to be deleted.

Returns:

bool:

Returns True

delete_checklist_item(checklist_id: str, checklist_item_id: str) → bool

Deletes an item from a checklist via a given checklist id and item id.

Args:

checklist_id (str):

The id of the ClickUp checklist to delete an item from.

checklist_item_id (str):

The id of the checklist item to be deleted.

delete_comment(comment_id: str) → bool

Deletes a comment via a given comment id.

Args:

comment_id (str):

The id of the comment to delete.

Returns:

bool:

True if successful.

delete_folder(folder_id: str) → None

Deletes a folder from a given folder ID.

Args:

folder_id (str):

The ID of the ClickUp folder to delete.

delete_goal(goal_id: str) → bool

Delete a goal via a given goal id.

Args:

goal_id (str):

The id of the goal to delete.

Returns:

bool:

Returns True.

delete_list(list_id: str) → bool

Deletes a list via a given list id.

Returns:

bool: Returns True if the list was successfully deleted.

delete_space(space_id: str)

delete_task(task_id: str) → None

Deletes a task via a given task ID.

Args:

folder_id (str):

The ID of the ClickUp task to delete.

get_chat_comments(view_id: str) → Comments

Get all the comments for a chat from a given view id.

Args:

view_id (str):

The id of the view to retrieve comments from.

Returns:

models.Comments:

Returns an object of type Comments.

get_folder(folder_id: str) → Folder

Fetches a single folder item from a given folder id and returns a Folder object.

Args:

folder_id (str):

The ID of the ClickUp folder to retrieve.

Returns:

Folder:

Returns an object of type Folder.

get_folderless_lists(space_id: str) → AllLists

Fetches all folderless lists from a given space id and returns a list of List objects.

Args:

space_id (str):

The ID of the ClickUp space to be returned.

Returns:

list.AllLists:

Returns a list of type AllLists.

get_folders(space_id: str) → Folders

Fetches all folders from a given space ID and returns a list of Folder objects.

Args:

space_id (str):

The ID of the ClickUp space to retrieve the list of folder from.

Returns:

Folders:

Returns a list of Folder objects.

get_goal(goal_id: str) → Goal

get_goal fetch a goal via a given goal id. Args:

goal_id (str):

The id of the goal to be fetched.

Returns:

models.Goal:

Returns an object of type Goal.

get_goals(team_id: str, include_completed: bool = False) → Goals

get_goals Returns a list of goals for a team via a given team id. Args:

team_id (str):

The id of the team to fetch goals for.

include_completed (bool, optional):

Setting this to true will include completed goals in the query. Defaults to False.

Returns:

models.Goals:

Returns an object of type Goals.

get_list(list_id: str) → SingleList

Fetches a single list item from a given list id and returns a List object.

Args:

list_id (str):

The id of the ClickUp list.

Returns:

models.SingleList:

Returns an object of type List.

get_list_comments(list_id: str) → Comments

Get all the comments for a list from a given list id.

Args:

list_id (str):

The id of the ClickUp list to retrieve comments from.

Returns:

models.Comments:

Returns an object of type Comments.

get_list_members(list_id: str) → Members

Get all members assigned to a specific list via a list id.

Args:

list_id (str):

The id of the list to get members of.

Returns:

models.Members:

Returns an object of type Members.

get_lists(folder_id: str) → AllLists

Fetches all lists from a given folder id and returns a list of List objects.

Args:

folder_id (str):

The ID of the ClickUp folder to be returned.

Returns:

list.AllLists:

Returns a list of type AllLists.

get_shared_hierarchy(team_id: str) → SharedHierarchy

Returns all resources you have access to where you don’t have access to its parent. For example, if you have a access to a shared task, but don’t have access to its parent list, it will come back in this request.

Args:

team_id (str):

The team id to fetch shared hierarchy for.

Returns:

models.SharedHierarchy:

Returns an object of type SharedHierarchy.

get_single_time_entry(team_id: str, timer_id: str) → TimeTrackingData

Gets a single time tracking object.

Args:

team_id (str):

The id of the team the time tracking data resides in.

timer_id (str):

The id of the time entry.

Returns:

models.TimeTrackingData:

[Returns an object of type TimeTrackingData.

get_space(space_id: str)

get_space_tags(space_id: str) → Tags

Gets all tags from a ClickUp space given the space id.

Args:

space_id (str):

The id of the space to return tags from.

Returns:

models.Tags:

Returns an object of type Tags.

get_spaces(team_id: str, archived: bool = False)

get_task(task_id: str) → Task

Fetches a single ClickUp task item and returns a Task object.

Args:

task_id (str):

The ID of the task to return.

Returns:

Task:

Returns an object of type Task.

get_task_comments(task_id: str) → Comments

Get all the comments for a task from a given task id.

Args:

task_id (str):

The id of the ClickUp task to retrieve comments from.

Returns:

models.Comments:

Returns an object of type Comments.

get_task_members(task_id: str) → Members

Get all members assigned to a specific task via a task id.

Args:

task_id (str):

The id of the task to get members of.

Returns:

models.Members:

Returns an object of type Members.

get_tasks(list_id: str, archived: bool = False, page: int = 0, order_by: str = 'created', reverse: bool = False, subtasks: bool = False, statuses: Optional[List[str]] = None, include_closed: bool = False, assignees: Optional[List[str]] = None, due_date_gt: Optional[str] = None, due_date_lt: Optional[str] = None, date_created_gt: Optional[str] = None, date_created_lt: Optional[str] = None, date_updated_gt: Optional[str] = None, date_updated_lt: Optional[str] = None) → Tasks

The maximum number of tasks returned in this response is 100. When you are paging this request, you should check list limit against the length of each response to determine if you are on the last page.

Args:

list_id (str):

The ID of the list to retrieve tasks from.

archived (bool, optional):

Include archived tasks in the retrieved tasks. Defaults to False.

page (int, optional):

Page to fetch (starts at 0). Defaults to 0.

order_by (str, optional):

Order by field, defaults to “created”. Options: id, created, updated, due_date.

reverse (bool, optional):

Reverse the order of the returned tasks. Defaults to False.

subtasks (bool, optional):

Include archived tasks in the retrieved tasks. Defaults to False.

statuses (List[str], optional):

Only retrieve tasks with the supplied status. Defaults to None.

include_closed (bool, optional):

Include closed tasks in the query. Defaults to False.

assignees (List[str], optional):

Retrieve tasks for specific assignees only. Defaults to None.

due_date_gt (str, optional):

Retrieve tasks with a due date greater than the supplied date. Defaults to None.

due_date_lt (str, optional):

Retrieve tasks with a due date less than the supplied date. Defaults to None.

date_created_gt (str, optional):

Retrieve tasks with a creation date greater than the supplied date. Defaults to None.

date_created_lt (str, optional):

Retrieve tasks with a creation date less than the supplied date. Defaults to None.

date_updated_gt (str, optional):

Retrieve tasks where the last update date is greater than the supplied date. Defaults to None.

date_updated_lt (str, optional):

Retrieve tasks where the last update date is greater than the supplied date. Defaults to None.

Raises:

exceptions.ClickupClientError:

Invalid order_by value

Returns:

models.Tasks:

Returns a list of item Task.

get_team_tasks(team_Id: str, page: int = 0, order_by: str = 'created', reverse: bool = False, subtasks: bool = False, space_ids: Optional[List[str]] = None, project_ids: Optional[List[str]] = None, list_ids: Optional[List[str]] = None, statuses: Optional[List[str]] = None, include_closed: bool = False, assignees: Optional[List[str]] = None, tags: Optional[List[str]] = None, due_date_gt: Optional[str] = None, due_date_lt: Optional[str] = None, date_created_gt: Optional[str] = None, date_created_lt: Optional[str] = None, date_updated_gt: Optional[str] = None, date_updated_lt: Optional[str] = None) → Tasks

Gets filtered tasks for a team.

Args:

team_Id (str):

The id of the team to get tasks for.

page (int, optional):

The starting page number. Defaults to 0.

order_by (str, optional):

Order by field, defaults to “created”. Options: id, created, updated, due_date.

reverse (bool, optional):

[description]. Defaults to False.

subtasks (bool, optional):

[description]. Defaults to False.

space_ids (List[str], optional):

[description]. Defaults to None.

project_ids (List[str], optional):

[description]. Defaults to None.

list_ids (List[str], optional):

[description]. Defaults to None.

statuses (List[str], optional):

[description]. Defaults to None.

include_closed (bool, optional):

[description]. Defaults to False.

assignees (List[str], optional):

[description]. Defaults to None.

tags (List[str], optional):

[description]. Defaults to None.

due_date_gt (str, optional):

[description]. Defaults to None.

due_date_lt (str, optional):

[description]. Defaults to None.

date_created_gt (str, optional):

[description]. Defaults to None.

date_created_lt (str, optional):

[description]. Defaults to None.

date_updated_gt (str, optional):

[description]. Defaults to None.

date_updated_lt (str, optional):

[description]. Defaults to None.

Raises:

exceptions.ClickupClientError: [description]

Returns:

models.Tasks: [description]

get_teams() → Teams

Get all teams from a workspace. Teams is the legacy term for what are now called Workspaces in ClickUp. For compatibility, the term team is still used in this API. This is NOT the new “Teams” feature which represents a group of users.

Returns:

models.Teams:

Returns an object of type Teams.

get_time_entries_in_range(team_id: str, start_date: Optional[str] = None, end_date: Optional[str] = None, assignees: Optional[List[str]] = None) → TimeTrackingData

Gets a list of time tracking entries for a specific date range.

Args:

team_id (str):

The id of the team to fetch time entries for.

start_date (str, optional):

The minimum date to fetch time entries for. Defaults to None.

end_date (str, optional):

The maximum date to fetch time entries for. Defaults to None.

assignees (List[str], optional):

A list of user ids to add as assignees. Defaults to None.

Returns:

models.TimeTrackingData:

Returns an object of type TimeTrackingData.

remove_task_from_list(task_id: str, list_id: str) → bool

Removes a task from a list via a given task id and list id.

Args:

task_id (str):

The id of the task to remove.

list_id (str):

The id of the list to remove the task from.

Returns:

bool:

Returns True.

start_timer(team_id: str, timer_id: str) → TimeTrackingData

start_timer Starts the time tracking timer for a task via a timer id.

Args:

team_id (str):

The id of the team the timer exists in.

timer_id (str):

The id of the timer to start tracking for.

Returns:

models.TimeTrackingData:

Returns an object of type TimeTrackingData.

stop_timer(team_id: str) → TimeTrackingData

Stops the time tracking timer for a task via a team id.

Args:

team_id (str):

The id of the team the timer exists in.

Returns:

models.TimeTrackingData:

Returns an object of type TimeTrackingData.

tag_task(task_id: str, tag_name: str)

untag_task(task_id: str, tag_name: str)

update_checklist(checklist_id: str, name: Optional[str] = None, postion: Optional[int] = None) → Checklist

update_checklist Updates a ClickUp checklist.

Args:

checklist_id (str):

The id of the checklist to be updated.

name (str, optional):

The name to update the checklist to. Defaults to None.

postion (int, optional):

The order position to update the checklist to. Defaults to None.

Returns:

models.Checklist:

Returns an object of type Checklist.

update_checklist_item(checklist_id: str, checklist_item_id: str, name: Optional[str] = None, resolved: Optional[bool] = None, parent: Optional[str] = None) → Checklist

Updates an item in a checklist via a given checklist id and item id.

Args:

checklist_id (str):

The id of the checklist the item resides in.

checklist_item_id (str):

The id of the checklist item to be updated.

name (str, optional):

New name for the checklist item. Defaults to None.

resolved (bool, optional):

boolean value indicated the resolution status of the checklist item. Defaults to None.

parent (str, optional):

The new parent for the checklist item. Defaults to None.

Returns:

models.Checklist:

[description]

update_comment(comment_id: str, comment_text: Optional[str] = None, assignee: Optional[str] = None, resolved: Optional[bool] = None) → Comment

Update a ClickUp comment’s content, assignee and resolution status.

Args:

comment_id (str):

The id of the comment to update

comment_text (str, optional):

The new content of the comment. Defaults to None.

assignee (str, optional):

The id of an assignee. Defaults to None.

resolved (bool, optional):

Comment resolution status. Defaults to None.

Returns:

models.Comment:

[description]

update_folder(folder_id: str, name: str) → Folder

Updates the name of a folder given the folder ID.

Args:

folder_id (str):

The ID of the ClickUp folder to update.

name (str):

String that the folder name will be updated to reflect.

Returns:

Folder:

Returns the updated Folder as an object.

update_goal(goal_id: str, name: Optional[str] = None, due_date: Optional[str] = None, description: Optional[str] = None, rem_owners: Optional[List[str]] = None, add_owners: Optional[List[str]] = None, color: Optional[str] = None) → Goal

Updates a goal via a given goal id.

Args:

goal_id (str):

The id of the goal to be updated.

name (str, optional):

New name for the goal. Defaults to None.

due_date (str, optional):

Due date for goal. Defaults to None.

description (str, optional):

Description of the goal. Defaults to None.

rem_owners (List[str], optional):

Remove owners from the goal. Defaults to None.

add_owners (List[str], optional):

Add owners to the goal. Defaults to None.

color (str, optional):

The color for the goal. Defaults to None.

Returns:

models.Goal: [description]

update_list(list_id: str, name: Optional[str] = None, content: Optional[str] = None, due_date: Optional[str] = None, due_date_time: Optional[bool] = None, priority: Optional[int] = None, assignee: Optional[str] = None, unset_status: Optional[bool] = None) → SingleList

update_task(task_id, name: Optional[str] = None, description: Optional[str] = None, status: Optional[str] = None, priority: Optional[int] = None, time_estimate: Optional[int] = None, archived: Optional[bool] = None, add_assignees: Optional[List[str]] = None, remove_assignees: Optional[List[int]] = None) → Task

[summary]

Args:

task_id ([type]):

The ID of the ClickUp task to update.

name (str, optional):

Sting value to update the task name to. Defaults to None.

description (str, optional):

Sting value to update the task description to. Defaults to None.

status (str, optional):

String value of the tasks status. Defaults to None.

priority (int, optional):

Priority of the task. Range 1-4. Defaults to None.

time_estimate (int, optional):

Time estimate of the task. Defaults to None.

archived (bool, optional):

Whether the task should be archived or not. Defaults to None.

add_assignees (List[str], optional):

List of assignee IDs to add to the task. Defaults to None.

remove_assignees (List[int], optional):

List of assignee IDs to remove from the task. Defaults to None.

Raises:

exceptions.ClickupClientError:

Raises “Priority out of range” exception for invalid priority range.

Returns:

models.Task:

Returns an object of type Task.

upload_attachment(task_id: str, file_path: str) → Attachment

Uploads an attachment to a ClickUp task.

Args:

task_id (str):

The ID of the task to upload to.

file_path (str):

The filepath of the file to upload.

Returns:

Attachment:

Returns an attachment object.

clickupython.exceptions module

exception clickupython.exceptions.ClickupClientError(error_message, status_code=None)

Bases: Exception

clickupython.models module

class clickupython.models.AllLists(*, lists: List[SingleList] = None)

Bases: BaseModel

build_lists()

lists: List[SingleList]

class clickupython.models.AssignedBy(*, id: str = None, username: str = None, initials: str = None, email: str = None, color: str = None, profile_picture: str = None)

Bases: BaseModel

color: str

email: str

id: str

initials: str

profile_picture: str

username: str

class clickupython.models.Asssignee(*, id: str = None, color: str = None, username: str = None, initials: str = None, profilePicture: str = None)

Bases: BaseModel

color: str

id: str

initials: str

profilePicture: str

username: str

class clickupython.models.Attachment(*, id: str, version: int, date: str, title: str, extension: str, thumbnail_small: str, thumbnail_large: str, url: str)

Bases: BaseModel

build_attachment()

date: str

extension: str

id: str

thumbnail_large: str

thumbnail_small: str

title: str

url: str

version: int

class clickupython.models.Checklist(*, id: str = None, task_id: str = None, name: str = None, orderindex: int = None, resolved: int = None, unresolved: int = None, items: List[ChecklistItem] = None)

Bases: BaseModel

add_item(client_instance, name: str, assignee: Optional[str] = None)

id: Optional[str]

items: List[ChecklistItem]

name: str

orderindex: int

resolved: int

task_id: str

unresolved: int

class clickupython.models.ChecklistItem(*, id: str = None, name: str = None, orderindex: int = None, assignee: Asssignee = None)

Bases: BaseModel

assignee: Optional[Asssignee]

id: str

name: str

orderindex: int

class clickupython.models.Checklists(*, checklist: Checklist)

Bases: BaseModel

build_checklist()

checklist: Checklist

class clickupython.models.ChecklistsStatus(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.ClickupList(*, id: str = None)

Bases: BaseModel

id: str

class clickupython.models.Comment(*, id: str = None, comment: List[CommentComment] = None, comment_text: str = None, user: AssignedBy = None, resolved: bool = None, assignee: AssignedBy = None, assigned_by: AssignedBy = None, reactions: List[Any] = None, date: str = None, hist_id: str = None)

Bases: BaseModel

assigned_by: AssignedBy

assignee: AssignedBy

build_comment()

comment: List[CommentComment]

comment_text: str

date: str

hist_id: str

id: str

reactions: List[Any]

resolved: bool

user: AssignedBy

class clickupython.models.CommentComment(*, text: str = None)

Bases: BaseModel

text: str

class clickupython.models.Comments(*, comments: List[Comment] = None)

Bases: BaseModel

build_comments()

comments: List[Comment]

class clickupython.models.Creator(*, id: int = None, username: str = None, color: str = None, profile_picture: str = None)

Bases: BaseModel

color: str

id: int

profile_picture: str

username: str

class clickupython.models.CustomField(*, id: str = None, name: str = None, type: str = None, type_config: TypeConfig = None, date_created: str = None, hide_from_guests: bool = None, value: Any = None, required: bool = None)

Bases: BaseModel

date_created: str

hide_from_guests: bool

id: str

name: str

required: bool

type: str

type_config: TypeConfig

value: Optional[Any]

class clickupython.models.CustomFieldsStatus(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.CustomItems(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.DependencyWarning(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.DueDates(*, enabled: bool = None, start_date: bool = None, remap_due_dates: bool = None, remap_closed_due_date: bool = None)

Bases: BaseModel

enabled: bool

remap_closed_due_date: bool

remap_due_dates: bool

start_date: bool

class clickupython.models.Emails(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.Features(*, due_dates: DueDates = None, multiple_assignees: MultipleAssignees = None, sprints: Sprints = None, start_date: bool = False, remap_due_dates: bool = False, remap_closed_due_date: bool = False, time_tracking: TimeTracking = None, tags: TagsStatus = None, time_estimates: TimeEstimateStatus = None, checklists: ChecklistsStatus = None, custom_fields: CustomFieldsStatus = None, remap_dependencies: RemapDependenciesStatus = None, dependency_warning: DependencyWarning = None, portfolios: PortfoliosStatus = None, points: Points = None, custom_items: CustomItems = None, zoom: Zoom = None, milestones: Milestones = None, emails: Emails = None)

Bases: BaseModel

class Config

Bases: object

validate_assignment = True

checklists: Optional[ChecklistsStatus]

custom_fields: Optional[CustomFieldsStatus]

custom_items: CustomItems

dependency_warning: DependencyWarning

due_dates: DueDates

emails: Emails

milestones: Milestones

multiple_assignees: MultipleAssignees

points: Points

portfolios: Optional[PortfoliosStatus]

remap_closed_due_date: bool

remap_dependencies: Optional[RemapDependenciesStatus]

remap_due_dates: bool

classmethod set_cf(custom_fields)

classmethod set_checklists(checklists)

classmethod set_ma(multiple_assignees)

classmethod set_portfolios(portfolios)

classmethod set_tags(tags)

classmethod set_tt(time_tracking)

sprints: Sprints

start_date: bool

tags: Optional[TagsStatus]

time_estimates: Optional[TimeEstimateStatus]

time_tracking: Optional[TimeTracking]

zoom: Zoom

class clickupython.models.Folder(*, id: str = None, name: str = None, orderindex: int = None, override_statuses: bool = False, hidden: bool = False, space: Space = None, task_count: int = None, lists: List[SingleList] = [])

Bases: BaseModel

build_folder()

delete(client_instance)

hidden: bool

id: str

lists: List[SingleList]

name: str

orderindex: int

override_statuses: bool

space: Optional[Space]

task_count: int

class clickupython.models.Folders(*, folders: List[Folder] = None)

Bases: BaseModel

build_folders()

folders: List[Folder]

class clickupython.models.Goal(*, id: str = None, name: str = None, team_id: int = None, date_created: str = None, start_date: str = None, due_date: str = None, description: str = None, private: bool = None, archived: bool = None, creator: int = None, color: str = None, pretty_id: int = None, multiple_owners: bool = None, folder_id: str = None, members: List[User] = None, owners: List[User] = None, key_results: List[Any] = None, percent_completed: int = None, history: List[Any] = None, pretty_url: str = None)

Bases: BaseModel

archived: bool

build_goal()

color: str

creator: int

date_created: str

description: str

due_date: str

folder_id: str

history: List[Any]

id: str

key_results: List[Any]

members: List[User]

multiple_owners: bool

name: str

owners: List[User]

percent_completed: int

pretty_id: int

pretty_url: str

private: bool

start_date: str

team_id: int

class clickupython.models.Goals(*, goal: Goal)

Bases: BaseModel

build_goals()

goal: Goal

class clickupython.models.GoalsList(*, goals: List[Goal] = None, folders: List[Folder] = None)

Bases: BaseModel

build_goals()

folders: List[Folder]

goals: List[Goal]

class clickupython.models.InvitedBy(*, id: str = None, username: str = None, color: str = None, email: str = None, initials: str = None, profile_picture: None = None)

Bases: BaseModel

color: str

email: str

id: str

initials: str

profile_picture: None

username: str

class clickupython.models.ListFolder(*, id: str, name: str, hidden: bool = None, access: bool)

Bases: BaseModel

access: bool

hidden: Optional[bool]

id: str

name: str

class clickupython.models.Member(*, user: User, invited_by: InvitedBy = None)

Bases: BaseModel

invited_by: Optional[InvitedBy]

user: User

class clickupython.models.Members(*, members: List[User] = None)

Bases: BaseModel

build_members()

members: List[User]

class clickupython.models.Milestones(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.MultipleAssignees(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.Option(*, id: str = None, name: str = None, color: str = None, order_index: int = None)

Bases: BaseModel

color: Optional[str]

id: Optional[str]

name: Optional[str]

order_index: Optional[int]

class clickupython.models.Points(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.PortfoliosStatus(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.Priority(*, id: int = None, priority: Any = None, color: str = None, orderindex: str = None)

Bases: BaseModel

color: str

id: int

orderindex: str

priority: Any

class clickupython.models.RemapDependenciesStatus(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.Shared(*, tasks: List[Tasks] = None, lists: List[SingleList] = None, folders: List[Folder] = None)

Bases: BaseModel

build_shared()

folders: Optional[List[Folder]]

lists: Optional[List[SingleList]]

tasks: Optional[List[Tasks]]

class clickupython.models.SharedHierarchy(*, shared: Shared)

Bases: BaseModel

build_shared()

shared: Shared

class clickupython.models.SingleList(*, id: str = None, name: str = None, deleted: bool = None, archived: bool = None, orderindex: int = None, override_statuses: bool = None, priority: Priority = None, assignee: Asssignee = None, due_date: str = None, start_date: str = None, folder: ListFolder = None, space: ListFolder = None, statuses: List[StatusElement] = None, inbound_address: str = None, permission_level: str = None, content: str = None, status: Status = None, task_count: int = None, start_date_time: str = None, due_date_time: bool = None)

Bases: BaseModel

archived: bool

assignee: Asssignee

build_list()

content: Optional[str]

deleted: bool

due_date: str

due_date_time: Optional[bool]

folder: ListFolder

id: str

inbound_address: str

name: str

orderindex: int

override_statuses: bool

permission_level: str

priority: Optional[Priority]

space: ListFolder

start_date: str

start_date_time: Optional[str]

status: Optional[Status]

statuses: Optional[List[StatusElement]]

task_count: Optional[int]

class clickupython.models.Space(*, id: str = None, name: str = None, access: bool = None, features: Features = None, multiple_assignees: bool = None, private: bool = False, statuses: List[Status] = None, archived: bool = None)

Bases: BaseModel

access: Optional[bool]

archived: Optional[bool]

build_space()

features: Optional[Features]

id: Optional[str]

multiple_assignees: Optional[bool]

name: Optional[str]

private: Optional[bool]

statuses: Optional[List[Status]]

class clickupython.models.SpaceFeatures(*, due_dates: bool = False, multiple_assignees: bool = False, start_date: bool = False, remap_due_dates: bool = False, remap_closed_due_date: bool = False, time_tracking: bool = False, tags: bool = False, time_estimates: bool = False, checklists: bool = False, custom_fields: bool = False, remap_dependencies: bool = False, dependency_warning: bool = False, portfolios: bool = False, points: bool = False, custom_items: bool = False, zoom: bool = False, milestones: bool = False, emails: bool = False)

Bases: BaseModel

property all_features

checklists: bool

custom_fields: bool

custom_items: bool

dependency_warning: bool

due_dates: bool

emails: bool

milestones: bool

multiple_assignees: bool

points: bool

portfolios: bool

remap_closed_due_date: bool

remap_dependencies: bool

remap_due_dates: bool

start_date: bool

tags: bool

time_estimates: bool

time_tracking: bool

zoom: bool

class clickupython.models.Spaces(*, spaces: List[Space] = None)

Bases: BaseModel

build_spaces()

spaces: List[Space]

class clickupython.models.Sprints(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.Status(*, id: str = None, status: str = None, color: str = None, orderindex: int = None, type: str = None)

Bases: BaseModel

color: str

id: Optional[str]

orderindex: int

status: str

type: str

class clickupython.models.StatusElement(*, id: str = None, status: str, orderindex: int, color: str, type: str)

Bases: BaseModel

color: str

id: Optional[str]

orderindex: int

status: str

type: str

class clickupython.models.Tag(*, name: str = None, tag_fg: str = None, tag_bg: str = None)

Bases: BaseModel

build_tag()

name: str

tag_bg: str

tag_fg: str

class clickupython.models.Tags(*, tags: List[Tag] = None)

Bases: BaseModel

build_tags()

tags: List[Tag]

class clickupython.models.TagsStatus(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.Task(*, id: str = None, custom_id: str = None, name: str = None, text_content: str = None, description: str = None, status: Status = None, orderindex: str = None, date_created: str = None, date_updated: str = None, date_closed: str = None, creator: Creator = None, assignees: List[Asssignee] = None, checklists: List[Any] = None, tags: List[Any] = None, parent: str = None, priority: Any = None, due_date: str = None, start_date: str = None, time_estimate: str = None, time_spent: str = None, custom_fields: List[CustomField] = None, list: ClickupList = None, folder: Folder = None, space: Folder = None, url: str = '')

Bases: BaseModel

add_comment(client_instance, comment_text: str, assignee: Optional[str] = None, notify_all: bool = True)

assignees: List[Asssignee]

build_task()

creator: Creator

custom_fields: Optional[List[CustomField]]

custom_id: str

date_closed: str

date_created: str

date_updated: str

delete()

description: str

due_date: str

folder: Folder

get_comments(client_instance)

id: str

list: ClickupList

name: str

orderindex: str

parent: str

priority: Any

space: Folder

start_date: str

status: Status

task_checklists: List[Any]

task_tags: List[Any]

text_content: str

time_estimate: str

time_spent: Optional[str]

update(client_instance, name: Optional[str] = None, description: Optional[str] = None, status: Optional[str] = None, priority: Optional[Any] = None, time_estimate: Optional[int] = None, archived: Optional[bool] = None, add_assignees: Optional[List[str]] = None, remove_assignees: Optional[List[int]] = None)

upload_attachment(client_instance, file_path: str)

url: str

class clickupython.models.Tasks(*, tasks: List[Task] = None)

Bases: BaseModel

build_tasks()

tasks: List[Task]

class clickupython.models.Team(*, id: str = None, name: str = None, color: str = None, avatar: str = None, members: List[Member] = None)

Bases: BaseModel

avatar: str

color: str

id: str

members: List[Member]

name: str

class clickupython.models.Teams(*, teams: List[Team] = None)

Bases: BaseModel

build_teams()

teams: List[Team]

class clickupython.models.TimeEstimateStatus(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

class clickupython.models.TimeTracking(*, enabled: bool = False, harvest: bool = False, rollup: bool = False)

Bases: BaseModel

enabled: bool

harvest: bool

rollup: bool

class clickupython.models.TimeTrackingData(*, id: str = '', task: Task = None, wid: str = '', user: User = None, billable: bool = False, start: str = '', end: str = '', duration: int = None, description: str = '', tags: List[Tag] = None, source: str = '', at: str = '')

Bases: BaseModel

at: str

billable: bool

build_data()

description: str

duration: int

end: str

id: str

source: str

start: str

tags: List[Tag]

task: Task

user: User

wid: str

class clickupython.models.TimeTrackingDataList(*, data: List[TimeTrackingData] = None)

Bases: BaseModel

build_data()

data: List[TimeTrackingData]

class clickupython.models.TimeTrackingDataSingle(*, data: TimeTrackingData = None)

Bases: BaseModel

build_data()

data: TimeTrackingData

class clickupython.models.TypeConfig(*, default: int = None, placeholder: str = None, new_drop_down: bool = None, options: List[Option] = None, include_guests: bool = None, include_team_members: bool = None)

Bases: BaseModel

default: Optional[int]

include_guests: Optional[bool]

include_team_members: Optional[bool]

new_drop_down: Optional[bool]

options: Optional[List[Option]]

placeholder: Optional[str]

class clickupython.models.User(*, id: str = None, username: str = None, initials: str = None, email: str = None, color: str = None, profilePicture: str = None, role: int = None, custom_role: None = None, last_active: str = None, date_joined: str = None, date_invited: str = None)

Bases: BaseModel

color: str

custom_role: None

date_invited: Optional[str]

date_joined: Optional[str]

email: str

id: str

initials: Optional[str]

last_active: Optional[str]

profilePicture: str

role: Optional[int]

username: str

class clickupython.models.Zoom(*, enabled: bool = False)

Bases: BaseModel

enabled: bool

Module contents