ClickupAPIWrapper#

class langchain_community.utilities.clickup.ClickupAPIWrapper[source]#

Bases: BaseModel

Wrapper for Clickup API.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

param access_token: str | None = None#
param folder_id: str | None = None#
param list_id: str | None = None#
param space_id: str | None = None#
param team_id: str | None = None#
attempt_parse_teams(input_dict: dict) → Dict[str, List[dict]][source]#

Parse appropriate content from the list of teams.

Parameters:

input_dict (dict)

Return type:

Dict[str, List[dict]]

create_folder(query: str) → Dict[source]#

Creates a new folder.

Parameters:

query (str)

Return type:

Dict

create_list(query: str) → Dict[source]#

Creates a new list.

Parameters:

query (str)

Return type:

Dict

create_task(query: str) → Dict[source]#

Creates a new task.

Parameters:

query (str)

Return type:

Dict

classmethod get_access_code_url(oauth_client_id: str, redirect_uri: str = 'https://google.com') → str[source]#

Get the URL to get an access code.

Parameters:

  • oauth_client_id (str)

  • redirect_uri (str)

Return type:

str

classmethod get_access_token(oauth_client_id: str, oauth_client_secret: str, code: str) → str | None[source]#

Get the access token.

Parameters:

  • oauth_client_id (str)

  • oauth_client_secret (str)

  • code (str)

Return type:

str | None

get_authorized_teams() → Dict[Any, Any][source]#

Get all teams for the user.

Return type:

Dict[Any, Any]

get_default_params() → Dict[source]#
Return type:

Dict

get_folders() → Dict[source]#

Get all the folders for the team.

Return type:

Dict

get_headers() → Mapping[str, str | bytes][source]#

Get the headers for the request.

Return type:

Mapping[str, str | bytes]

get_lists() → Dict[source]#

Get all available lists.

Return type:

Dict

get_spaces() → Dict[source]#

Get all spaces for the team.

Return type:

Dict

get_task(query: str, fault_tolerant: bool = True) → Dict[source]#

Retrieve a specific task.

Parameters:

  • query (str)

  • fault_tolerant (bool)

Return type:

Dict

get_task_attribute(query: str) → Dict[source]#

Update an attribute of a specified task.

Parameters:

query (str)

Return type:

Dict

query_tasks(query: str) → Dict[source]#

Query tasks that match certain fields

Parameters:

query (str)

Return type:

Dict

run(mode: str, query: str) → str[source]#

Run the API.

Parameters:

  • mode (str)

  • query (str)

Return type:

str

update_task(query: str) → Dict[source]#

Update an attribute of a specified task.

Parameters:

query (str)

Return type:

Dict

update_task_assignees(query: str) → Dict[source]#

Add or remove assignees of a specified task.

Parameters:

query (str)

Return type:

Dict

Examples using ClickupAPIWrapper